File: firstboot.mli

package info (click to toggle)
guestfs-tools 1.52.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 69,236 kB
  • sloc: ansic: 15,698; ml: 15,621; sh: 7,396; xml: 5,478; makefile: 3,601; perl: 1,535; lex: 135; yacc: 128; python: 80
file content (70 lines) | stat: -rw-r--r-- 3,168 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
(* virt-customize
 * Copyright (C) 2012-2019 Red Hat Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *)

val firstboot_dir : Guestfs.guestfs -> string -> string * string option
(** [firstboot_dir g root]
    returns the path of the firstboot directory, creating it in
    the guest if necessary.

    This returns the name of the directory as a guestfs path, and
    optionally the name as a Windows path (only for Windows guests).

    For Linux this could be [/usr/lib/virt-sysprep, None]

    For Windows this could be ["/Program Files/Guestfs/Firstboot",
    Some "C:\Program Files\Guestfs\Firstboot"]

    Additional files that are used during firstboot can be placed
    in this directory, but be careful not to conflict with files
    and scripts added by the firstboot process itself. *)

val add_firstboot_script : Guestfs.guestfs -> string -> ?prio:int -> string ->
                           string -> unit
  (** [add_firstboot_script g root prio name content] adds a firstboot
      script called [name] containing [content] with priority [prio].

      [g] is the guestfs handle.  The disks must be mounted up and
      inspection data must be available.

      [content] is the contents of the script, {b not} a filename.

      The script is running using the shell (usually [/bin/sh]) on Linux
      or as a Windows batch file.  To use Windows Powershell, see
      {!add_firstboot_powershell} instead.

      The actual name of the script on the guest filesystem is made of [name]
      with all characters but alphanumeric replaced with dashes.

      Within a given priority, the scripts are run in the order they are
      registered. A group of scripts with a numerically lower priority is run
      before a group with a numerically greater priority. If [prio] is omitted,
      it is taken as 5000. If [prio] is smaller than 0 or greater than 9999, an
      Assert_failure is raised (the [prio] parameter is not expected to depend
      on user input).

      For Linux guests using SELinux you should make sure the
      filesystem is relabelled after calling this. *)

val add_firstboot_powershell : Guestfs.guestfs -> string ->
                               ?prio:int -> string -> string list -> unit
(** [add_firstboot_powershell] is like {!add_firstboot_script} except
    that it adds a Windows Powershell script instead of a batch
    file.

    The parameters are: [g root prio name lines] (where the Powershell
    script is passed in as lines of code). *)