Libosinfo.InstallConfig¶

Subclasses:: None

Methods¶

Inherited:: Libosinfo.Entity (15), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (id)
	`get_admin_password` ()
	`get_avatar_disk` ()
	`get_avatar_location` ()
	`get_driver_signing` ()
	`get_hardware_arch` ()
	`get_hostname` ()
	`get_installation_url` ()
	`get_l10n_keyboard` ()
	`get_l10n_language` ()
	`get_l10n_timezone` ()
	`get_post_install_drivers_disk` ()
	`get_post_install_drivers_location` ()
	`get_pre_install_drivers_disk` ()
	`get_pre_install_drivers_location` ()
	`get_reg_login` ()
	`get_reg_password` ()
	`get_reg_product_key` ()
	`get_script_disk` ()
	`get_target_disk` ()
	`get_user_administrator` ()
	`get_user_autologin` ()
	`get_user_login` ()
	`get_user_password` ()
	`get_user_realname` ()
	`set_admin_password` (password)
	`set_avatar_disk` (disk)
	`set_avatar_location` (location)
	`set_driver_signing` (signing)
	`set_hardware_arch` (arch)
	`set_hostname` (hostname)
	`set_installation_url` (url)
	`set_l10n_keyboard` (keyboard)
	`set_l10n_language` (language)
	`set_l10n_timezone` (tz)
	`set_post_install_drivers_disk` (disk)
	`set_post_install_drivers_location` (location)
	`set_pre_install_drivers_disk` (disk)
	`set_pre_install_drivers_location` (location)
	`set_reg_login` (name)
	`set_reg_password` (password)
	`set_reg_product_key` (key)
	`set_script_disk` (disk)
	`set_target_disk` (disk)
	`set_user_administrator` (admin)
	`set_user_autologin` (autologin)
	`set_user_login` (username)
	`set_user_password` (password)
	`set_user_realname` (name)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: Libosinfo.Entity (1)

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Libosinfo.Entity`	r

Class Details¶

class Libosinfo.InstallConfig(**kwargs)¶

Bases:: Libosinfo.Entity
Abstract:: No
Structure:: Libosinfo.InstallConfigClass

classmethod new(id)¶

Parameters:: id (str) – the unique identifier
Returns:: an install configuration with default values
Return type:: Libosinfo.InstallConfig

Construct a new install configuration with default values for language, keyboard, timezone and admin password. The default values are to use an ‘en_US’ language and keyboard, and an ‘America/New_York’ timezone. The admin password is set to a random 8 character password.

New in version 0.2.0.

get_admin_password()¶

Returns:: The value of Libosinfo.INSTALL_CONFIG_PROP_ADMIN_PASSWORD parameter, or None.
Return type:: str

New in version 0.2.0.

get_avatar_disk()¶

Returns:: The value of Libosinfo.INSTALL_CONFIG_PROP_AVATAR_DISK parameter, or None.
Return type:: str

New in version 0.2.2.

get_avatar_location()¶

Returns:: The value of Libosinfo.INSTALL_CONFIG_PROP_AVATAR_LOCATION parameter, or None.
Return type:: str

New in version 0.2.2.

get_driver_signing()¶

Returns:: True if driver signing is currently enabled, False otherwise, see Libosinfo.InstallConfig.set_driver_signing() for more details about driver signing.
Return type:: bool

New in version 0.2.6.

get_hardware_arch()¶

Returns:: The value of Libosinfo.INSTALL_CONFIG_PROP_HARDWARE_ARCH parameter, or None.
Return type:: str

New in version 0.2.8.

get_hostname()¶

Returns:: The value of Libosinfo.INSTALL_CONFIG_PROP_HOSTNAME parameter, or None.
Return type:: str

New in version 0.2.8.

get_installation_url()¶

Return type:: str

Returns the URL the script will use to perform the installation.

New in version 1.5.0.

get_l10n_keyboard()¶

Returns:: The value of Libosinfo.INSTALL_CONFIG_PROP_L10N_KEYBOARD parameter, or None.
Return type:: str

New in version 0.2.0.

get_l10n_language()¶

Returns:: The value of Libosinfo.INSTALL_CONFIG_PROP_L10N_LANGUAGE parameter, or None.
Return type:: str

New in version 0.2.0.

get_l10n_timezone()¶

Returns:: The value of Libosinfo.INSTALL_CONFIG_PROP_L10N_TIMEZONE parameter, or None.
Return type:: str

New in version 0.2.0.

get_post_install_drivers_disk()¶

Returns:: The disk on which post-installation drivers are located, or None if its not set using Libosinfo.InstallConfig.set_post_install_drivers_disk().
Return type:: str

New in version 0.2.2.

get_post_install_drivers_location()¶

Returns:: The disk on which post-installation drivers are located, or None if its not set using Libosinfo.InstallConfig.set_post_install_drivers_location().
Return type:: str

New in version 0.2.2.

get_pre_install_drivers_disk()¶

Returns:: The disk on which pre-installation drivers are located, or None if its not set using Libosinfo.InstallConfig.set_pre_install_drivers_disk().
Return type:: str

New in version 0.2.2.

get_pre_install_drivers_location()¶

Returns:: The location on which pre-installation drivers are located, or None if its not set using Libosinfo.InstallConfig.set_pre_install_drivers_location().
Return type:: str

New in version 0.2.2.

get_reg_login()¶

Returns:: The value of Libosinfo.INSTALL_CONFIG_PROP_REG_LOGIN parameter, or None.
Return type:: str

New in version 0.2.8.

get_reg_password()¶

Returns:: The value of Libosinfo.INSTALL_CONFIG_PROP_REG_PASSWORD parameter, or None.
Return type:: str

New in version 0.2.8.

get_reg_product_key()¶

Returns:: The value of Libosinfo.INSTALL_CONFIG_PROP_REG_PRODUCTKEY parameter, or None.
Return type:: str

New in version 0.2.8.

get_script_disk()¶

Returns:: The value of Libosinfo.INSTALL_CONFIG_PROP_SCRIPT_DISK parameter, or None.
Return type:: str

New in version 0.2.2.

get_target_disk()¶

Returns:: The value of Libosinfo.INSTALL_CONFIG_PROP_TARGET_DISK parameter, or None.
Return type:: str

New in version 0.2.2.

get_user_administrator()¶

Returns:: The value of Libosinfo.INSTALL_CONFIG_PROP_USER_ADMIN parameter, or None.
Return type:: bool

New in version 0.2.0.

get_user_autologin()¶

Returns:: The value of Libosinfo.INSTALL_CONFIG_PROP_USER_AUTOLOGIN parameter, or None.
Return type:: bool

New in version 0.2.0.

get_user_login()¶

Returns:: The value of Libosinfo.INSTALL_CONFIG_PROP_USER_LOGIN parameter, or None.
Return type:: str

New in version 0.2.0.

get_user_password()¶

Returns:: The value of Libosinfo.INSTALL_CONFIG_PROP_USER_PASSWORD parameter, or None.
Return type:: str

New in version 0.2.0.

get_user_realname()¶

Returns:: The value of Libosinfo.INSTALL_CONFIG_PROP_USER_REALNAME parameter, or None.
Return type:: str

New in version 0.2.0.

set_admin_password(password)¶

Parameters:: password (str) – the administrator password to be set

Sets the Libosinfo.INSTALL_CONFIG_PROP_ADMIN_PASSWORD parameter

New in version 0.2.0.

set_avatar_disk(disk)¶

Parameters:: disk (str) – the avatar disk

Sets the Libosinfo.INSTALL_CONFIG_PROP_AVATAR_DISK parameter.

Please read documentation on Libosinfo.InstallConfig.set_target_disk() for explanation on the format of disk string.

New in version 0.2.2.

set_avatar_location(location)¶

Parameters:: location (str) – new location

Sets the Libosinfo.INSTALL_CONFIG_PROP_AVATAR_LOCATION parameter.

Note that the format of this string is dependent on the installer script self is going to be used with. You can use Libosinfo.InstallScript.get_path_format() to find out which format does the script expects this string to be in.

Also note that in case of Libosinfo.PathFormat.DOS, the drive/disk letter and the leading ‘:’ must not be included in the path.

New in version 0.2.2.

set_driver_signing(signing)¶

Parameters:: signing (bool) – boolean value

If a script requires drivers to be signed, this function can be used to disable that security feature. WARNING: Disabling driver signing may very well mean disabling it permanently.

New in version 0.2.6.

set_hardware_arch(arch)¶

Parameters:: arch (str) – the hardware architecture

Sets the Libosinfo.INSTALL_CONFIG_PROP_HARDWARE_ARCH parameter.

The list of valid architectures are part of osinfo.rng schema

New in version 0.2.0.

set_hostname(hostname)¶

Parameters:: hostname (str) – the desired hostname

Sets the Libosinfo.INSTALL_CONFIG_PROP_HOSTNAME parameter.

Note that some operating systems have restrictions on maximum number of, and allowed characters in hostname (or its equivalent) so it is highly recommended that you keep the actual hostname less than or equal to 15 characters long and make sure that it does not contain any characters other than ASCII alphanumeric and ‘-’. Otherwise unattended installation might fail.

New in version 0.2.0.

set_installation_url(url)¶

Parameters:: url (str) – the URL used to perform the installation

When performing a tree based installation the script will need the installation URL to be set, whenever the installation is performed from a non canonical place.

New in version 1.5.0.

set_l10n_keyboard(keyboard)¶

Parameters:: keyboard (str) – the keyboard

Sets the Libosinfo.INSTALL_CONFIG_PROP_L10N_KEYBOARD parameter.

The expected format of this string is the same as Libosinfo.InstallConfig.set_l10n_language function’s ‘language’ parameter.

New in version 0.2.0.

set_l10n_language(language)¶

Parameters:: language (str) – the language

Sets the Libosinfo.INSTALL_CONFIG_PROP_L10N_LANGUAGE parameter.

The expected format of this string is the gettext locale names standard:

https://www.gnu.org/savannah-checkouts/gnu/gettext/manual/html_node/Locale-Names.html

Encoding and variant are (at least for now) not supported. For example, ‘pt_BR’ is accepted is accepted as the language codes for Brazilian Portuguese but ‘pt_BR.utf8’ is not.

New in version 0.2.0.

set_l10n_timezone(tz)¶

Parameters:: tz (str) – the timezone

Set the Libosinfo.INSTALL_CONFIG_PROP_L10N_TIMEZONE parameter.

The expected format of this string is the tzdata names standard.

New in version 0.2.0.

set_post_install_drivers_disk(disk)¶

Parameters:: disk (str) – the target disk

Specify the disk on which drivers to be installed at the end of installation, are available.

Please read documentation on Libosinfo.InstallConfig.set_target_disk() for explanation on the format of disk string.

NOTE: Not every install script supports post-installation of drivers. Use Libosinfo.InstallScript.get_can_post_install_drivers() to find out if an install script supports it.

New in version 0.2.2.

set_post_install_drivers_location(location)¶

Parameters:: location (str) – the location of avatar

Specify the disk on which drivers to be installed at the end of installation, are available.

Please read documentation on Libosinfo.InstallConfig.set_avatar_location() for explanation on the format of location string.

NOTE: Not every install script supports post-installation of drivers. Use Libosinfo.InstallScript.get_can_post_install_drivers() to find out if an install script supports it.

New in version 0.2.2.

set_pre_install_drivers_disk(disk)¶

Parameters:: disk (str) – the disk

Specify the disk on which drivers to be installed at the very beginning of installation, are available. This is usually needed for devices for which the OS in question does not have out of the box support for and devices are required/preferred to be available during actual installation.

Please read documentation on Libosinfo.InstallConfig.set_target_disk() for explanation on the format of disk string.

NOTE: Not every install script supports pre-installation of drivers. Use Libosinfo.InstallScript.get_can_pre_install_drivers() to find out if an installer script supports it.

NOTE: Microsoft Windows XP requires pre-installation driver files to be present in the script disk under the toplevel directory.

New in version 0.2.2.

set_pre_install_drivers_location(location)¶

Parameters:: location (str) – the location

Specify the location on which drivers to be installed at the very beginning of installation, are available. Please read documentation on Libosinfo.InstallConfig.set_pre_install_drivers_disk() for more information about pre-installation of drivers.

Please read documentation on Libosinfo.InstallConfig.set_avatar_location() for explanation on the format of location string.

New in version 0.2.2.

set_reg_login(name)¶

Parameters:: name (str) – the registration login

Sets the value of Libosinfo.INSTALL_CONFIG_PROP_REG_LOGIN parameter.

New in version 0.2.0.

set_reg_password(password)¶

Parameters:: password (str) – the registration password

Sets the value of Libosinfo.INSTALL_CONFIG_PROP_REG_PASSWORD parameter.

New in version 0.2.0.

set_reg_product_key(key)¶

Parameters:: key (str) –

set_script_disk(disk)¶

Parameters:: disk (str) – the disk

Sets the Libosinfo.INSTALL_CONFIG_PROP_SCRIPT_DISK parameter.

Please read documentation on Libosinfo.InstallConfig.set_target_disk() for explanation on the format of disk string.

New in version 0.2.2.

set_target_disk(disk)¶

Parameters:: disk (str) – the target disk

Sets the Libosinfo.INSTALL_CONFIG_PROP_TARGET_DISK parameter.

Note that the format of this string is dependent on the installer script self is going to be used with. You can use Libosinfo.InstallScript.get_path_format() to find out which format does the script expects this string to be in. In case of Libosinfo.PathFormat.UNIX unix device node names are expected, e.g “/dev/fd0”. In case of Libosinfo.PathFormat.DOS drive letters are expected, e.g “A”.

New in version 0.2.2.

set_user_administrator(admin)¶