Skip to content
Olivier LAHAYE edited this page May 21, 2019 · 14 revisions

SystemImager v5 pre imager parameters

See manuals systemimager.cmdline(7) and dracut.cmdline(7) for detailed descriptions.

__Note: not all parameters are available depending on the way you specify them. si. is used on PXE cmdline.

Shell variable can be used in file specified by si.config or in local.cfg. Some of them can be updated in pre-install main-install and post-install scripts. Depending of the imaging progress, updating some variables can be a non-sense (changing DL_PROTOCOL has no meaning except in local.cfg, changing IMAGENAME in post-install has no meaning either for instance) Parameters are stored in /tmp/variables.txt and are accessible to pre-install main-install and post-install scripts during imaging.

si.break (no default)

  • force a debug shell at specified breakpoint. you can have more than one si.break= parameter This complement the rd.break from dracut (man dracut.cmdline for detailed list). The break occurs just before specified step would start. Possible values:
    • parse-localcfg
    • network-infos
    • ping
    • download-scripts
    • monitor
    • deploy
    • pre-install
    • prepare-disks
    • main-install
    • download-image
    • extract-image
    • install-overrides
    • install-configs
    • boot-loader
    • post-install
    • se-linux
    • umount-client
    • terminate-transfer
    • finished

si.debug (default: "n")

  • enable/disable debug messages.
    • Shell variable: $DEBUG

si.config (no default)

  • imaging config file. overrides cmdline variables
    • Shell variable: $SIS_CONFIG

si.image-name (defaults to hostname)

  • it defines the image name
    • Shell variable: $IMAGENAME

si.script-name (defaults to image-name)

  • it defines the main install script name. Imager will look for $SCRIPTNAME, $SCRIPTNAME.sh, $SCRIPTNAME.master
    • Shell variable: $SCRIPTNAME

si.disks-layout (defaults to image-name)

  • it defines how disk(s) must be initialized. Imager will look for $DISKS_LAYOUT and $DISKS_LAYOUT.xml
    • Shell variable: $DISKS_LAYOUT
    • man systemimager.disks-lauyout(7) for xml file format description.

si.network-config (defaults to image-name)

  • it defines the network interface(s) configuration (including aliases, bonding, ...). Imager will look for $NETWORK_CONFIG and $NETWORK_CONFIG.xml
    • Shell variable: $NETWORK_CONFIG
    • man systemimager.network-config(7) for xml file format description.

si.dl-protocol (defaults to rsync)

  • it defines the download protocol to use when imaging. imager tries do guess it and defaults to rsync
    • Shell variable: $DL_PROTOCOL

si.monitor-server (defaults to systemimager server)

  • points to server which listen for client console log output.
    • Shell variable: $MONITOR_SERVER

si.monitor-console (defaults to no. Possible values: 0,1,y,yes,n,no)

  • tells imager if conole messgaes must be sent to systemimager monitor (so si_monitortk can display them remotely)
    • Shell variable: $MONITOR_CONSOLE

si.skip-local-cfg (defaults to "n". Possible values: 0,1,y,yes,n,no)

  • tells imager if it should try to search for a local.cfg file
    • shell variable: $SKIP_LOCAL_CFG

si.image-server (no defaults)

  • tells imager where to fetch image
    • Shell variable: $IMAGESERVER

si.log-server-port (defaults: 514)

  • tells imager what is the remote syslog server port is.
    • Shell variable: $LOG_SERVER_PORT

si.ssh-client (defaults to "n". Possible values: 0,1,y,yes,n,no)

  • tells imager if it needs to start ssh client (tunnel to image server)
    • Shell variable: $SSH

si.ssh-download-url (no default)

  • tells imager the ssh URL needed to fetch the image.
    • If set, si.ssh-client is forced to "y" and si.dl-protocol is set to ssh if not yet defined.
    • shell variable: $SSH_DOWNLOAD_URL

si.ssh-server (defaults to "n". Possible values: 0,1,y,yes,n,no)

  • tells imager to start an ssh server while imaging so you can connect remotely from server (need explanation on how to login)
    • Shell variable: $SSHD

si.ssh-user (defaults to root)

  • tells imager which username should be used to create the ssh tunnel.
    • Shell variable: $SSH_USER

si.flamethrower-directory-portbase (no defaults)

  • tells imager the flathrower path.
    • if si.dl-protocol is not set, set DL_PROTOCOL to flametrower
    • Shell variable: $FLAMETHROWER_DIRECTORY_PORTBASE

si.tmpfs-staging (staging dir for image storage before it is written to disk. (not recommanded)

  • shell variable: $TMPFS_STAGING

si.term (defaults to linux)

  • tells imager what terminal type for imaged client console it should use
    • sell variable: $TERM

si.selinux-relabel (defaults to "y". Possible values: 0,1,y,yes,n,no)

  • tells to imager to force a SE Linux relabel after imaging or at next boot.
    • Shell variable: $SEL_RELABEL

si.post-action (defaults to reboot. Possible values: shell, reboot, shutdown, kexec, poweroff, directboot)

  • tells imager what to do when job is done.
    • shell: drop a shell after imaging
    • directboot: if imager kernel has matching modules in /sysroot/lib/modules/${uname -r}/ then it just continue boot like a normal boot without rebooting, otherwize it'll reboot.
    • shutdown or poweroff: stop the system
    • Shell variable: $SI_POST_ACTION