YaST2 Developers Documentation: Unknown YCP Module

Unknown YCP Module

This module has an unstable interface.

Imports

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

Structures

Global Variables

Global Functions

Local Variables

Local Functions

Info:

File: ImageInstallation.ycp

Module: ImageInstallation

Summary: Support functions for installation via images

Authors: Jiri Srain Lukas Ocilka

local _repo -> integer

Repository holding all images

global SetRepo (integer repo) -> void

Set the repository to get images from

Parameters:
repo integer the repository identification
local InitRepo () -> void

Adjusts the repository for images

local _images -> map<string,map<string,any> >

Description of all available images

local _image_order -> list<string>

Order of images

local _metadata_image -> string

Image with software management metadata

local _image_path -> string

Template for the path for an image on the media

local _mounted_images -> list<string>

List of already mounted images

local images_details -> map <string, map <string, integer> >

Structure $[

   "image_filaname" : $[
     // size of an unpacked image in bytes
     "size" : integer,
     // number of files and directories in an image
     "files" : integer,
   ]
 ]
local _current_image -> map <string, any>

Image currently being deployed

local _checkpoint -> integer

display progress messages every NUMBERth record

local _record_size -> integer

NUMBER of bytes per record, multiple of 512

global image_installation_available -> boolean

Defines whether some installation images are available

global SwMgmtImage () -> string

Name of image containing software management metadata (if exists)

Return value:
image with sw mgmt metadata
global ImageOrder () -> list<string>

Order of images to be deployed

Return value:
a list of images definint the order
local GetCurrentImages () -> map <string,map <string,any> >

Returns list of currently selected images.

Structure $[

   "image_id":$[
     "file":filename,
     "type":type
   ], ...
 ]
Return value:
images
See
AddImage
local AddImage (string name, string file, string type) -> void

Add information about new image

Parameters:
name string the name/id of the image
file string the file name of the image
type string the type of the image, one of "tar" and "fs"
local RemoveTemporaryImage (string image) -> void

Removes the downloaded image. If the file is writable, releases all sources because only libzypp knows which files are copies and which are just symlinks to sources (e.g., nfs://, smb://).

Parameters:
image
local DeployTarImage (string id, string target) -> boolean

Deploy an image of the filesystem type

Parameters:
id string the id of the image
target string the directory to deploy the image to
Return value:
true on success
local DeployFsImage (string id, string target) -> boolean

Deploy an image of the filesystem type

Parameters:
id string the id of the image
target string the directory to deploy the image to
Return value:
true on success
local MountFsImage (string id, string target) -> boolean

Mount an image of the filesystem type Does not integrate to the system, mounts on target

Parameters:
id string the id of the image
target string the directory to deploy the image to
Return value:
true on success
local _DeployImage (string id, string target, boolean temporary) -> boolean

Deploy an image (internal implementation)

Parameters:
id string the id of the image
target string the directory to deploy the image to
temporary boolean true to only mount if possible (no copy)
Return value:
true on success
global DeployImage (string id, string target) -> boolean

Deploy an image

Parameters:
id string the id of the image
target string the directory to deploy the image to
Return value:
true on success
global DeployImageTemporarily (string id, string target) -> boolean

Deploy an image temporarily (just mount if possible)

Parameters:
id string the id of the image
target string the directory to deploy the image to,
Return value:
true on success
global CleanTemporaryImage (string id, string target) -> boolean

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

Parameters:
id string the id of the image
target string the directory to deploy the image to,
Return value:
true on success
global FillUpImagesDetails () -> boolean

Loads non-mandatory details for every single selected image.

global DeployImages (list<string> images, string target) -> boolean

Deploy all images

Parameters:
images a list of images to deploy
target string directory where to deploy the images
local CountMatchingPatterns (list <string> imageset_patterns, list <string> installed_patterns) -> integer

Returns the intersection of both patterns supported by the imageset and patterns going to be installed.

Parameters:
imageset_patterns
installed_patterns
global FindImageSet (list<string> patterns) -> boolean

Find a set of images which suites selected patterns

Parameters:
patterns a list of patterns which are selected
Return value:
true on success or when media does not contain any images
global ImagesToUse () -> map

Returns map with description which images will be used

Structure $[

   "deploying_enabled" : boolean,
   "images" : returned by GetCurrentImages()
 ]
Return value:
with description
See
GetCurrentImages()
global FileSystemCopy (string from, string to, integer progress_start, integer progress_finish) -> boolean

Copy a subtree, limit to a single filesystem

Parameters:
from string source directory
to string target directory
progress_start
progress_finish
Return value:
true on success
Info:

List of all handled types.

local objects_state -> map <symbol, map <string, list <map> > >

Map that stores all the requested states of all handled/supported types.

global StoreAllChanges () -> void

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

See
all_supported_types objects_state
local ProceedWithSelected (map <string, any> & one_object, symbol & one_type) -> boolean

Parameters:
one_object
one_type
Return value:
whether the package should be additionally installed
global RestoreAllChanges () -> boolean

Restores packages statuses from 'objects_state': Selects packages for removal, installation, upgrade.

Return value:
if successful