| 5. Configuration file | ||
|---|---|---|
 |  | |
| 5. Configuration file | ||
|---|---|---|
| | | |
When AutoYaST is invoked, it checks for the desktop files in
/usr/share/applications/YaST2 and evaluates them to
later include them in the configuration interface. AutoYaST uses the same configuration file used for the YaST2
Control Center with some additional enhancements.
The following is an example of the configuration file for the NIS module:
Example 3. Auto-Install Configuration file for NIS
[Desktop Entry]
Type=Application
Categories=Qt;X-SuSE-YaST;X-SuSE-YaST-Net_advanced;
X-KDE-ModuleType=Library
X-KDE-RootOnly=true
X-KDE-HasReadOnlyMode=true
X-KDE-Library=yast2
X-SuSE-YaST-Call=nis
X-SuSE-YaST-Group=Net_advanced
X-SuSE-YaST-Argument=
X-SuSE-YaST-RootOnly=true
X-SuSE-YaST-AutoInst=all
X-SuSE-YaST-Geometry=
X-SuSE-YaST-SortKey=
X-SuSE-YaST-AutoInstClonable=true
X-SuSE-YaST-AutoLogResource=true
Icon=nis_client
Exec=/sbin/yast2 nis
Name=NIS Client
GenericName=Configure NIS client
In addition to the keywords from the last example, AutoYaST also evaluates the following keywords:
X-SuSE-YaST-AutoInst - Is the module compatible with the AutoYaST and can Import/Export configurations?
Values
all: Full auto-installation support, including the AutoYaST interface and writing configurations during autoinstall.
write: Write only support. No integration into AutoYaST interface.
configure: Configuration only support. Normally used only with parts related to installation like partitioning and general options which have no run-time module with support for auto-installation. Data is written using the common installation process and modules available in YaST2
X-SuSE-YaST-AutoInstPath - Path in the control file
Values
configure or install: All run-time configuration modules are contained in the configure resource. Only configuration data directly touching the installation of a system are contained in the install resource.
X-SuSE-YaST-AutoInstClient - Name of the client to call
Values
Name of the client to be called by AutoYaST
Default Value
<module name>_auto
X-SuSE-YaST-AutoInstDataType - Data type of configuration section
Values
map or list
Default Value
map
X-SuSE-YaST-AutoInstResource - Name of the resource in the Profile
Values
string
Default Value
(empty)
X-SuSE-YaST-AutoInstRequires - What modules are required before this module is run.
Values
comma delimited list of required modules
Default Value
(empty list)
X-SuSE-YaST-AutoInstMerge - Multiple sections in the profile can be handled by one module
Values
comma delimited list of sections to merge (see also X-SuSE-YaST-AutoInstMergeTypes)
The Users module for example handles also groups and user_defaults.
Default Value
(empty)
X-SuSE-YaST-AutoInstMergeTypes - Which datatypes are the section of that will be merged to be handled by one module
Values
comma delimited list of datatypes (list or map) for the sections from X-SuSE-YaST-AutoInstMerge
Default Value
(empty)
X-SuSE-YaST-AutoInstClonable - is this module able to clone the actual system
Values
a boolean (true,false)
If this is true, the module will appear in the list of modules you can choose from during the cloning of the actual system. Your module will Read() and Export() it's data from the actual system then.
Default Value
false
X-SuSE-YaST-AutoInstSchema - base name of schema file, including the rnc extension (Relax NG compact syntax)
Values
string
Default Value
(empty)
X-SuSE-YaST-AutoInstOptional - is the element optional in the schema
Values
a boolean (true,false)
Does this element has to appear in the profile? Unless you have a very basic module, this is always true.
Default Value
true
X-SuSE-YaST-AutoLogResource - is the resource of your modul allowed to be logged (since SLES10SP1/10.2)
Values
a boolean (true,false)
Do you allow autoyast to log the data of your resource into the logfile? The default is true but if you have sensible data like passwords, you might want to set this to false. That can always be overridden by Y2DEBUG=1
Default Value
true
| | | |
| Write() |  | 6. Conventions for module Writers |