zipl-editenv - Edit the zipl environment block

7.1 LPAR mode z/VM guest

Use the zipl-editenv command to display and change the zipl environment block.

Modifications that are made with zipl-editenv are lost after rerunning zipl. Modifications that are made with the zipl-editenv command do not affect the zipl environment file. Keep the environment file current to avoid inconsistencies. For more information about the zipl environment file, see zipl environment - Variables for the kernel command line.

CAUTION: Do not modify the zipl environment block by any other means than the zipl-editenv command.

zipl-editenv syntax


1  zipl-editenv 
2.1! -t /boot
2.1 -t<target_dir>
2.1 -l
2.1 
2.2.1 -s<keyword>=<value>
2.2.1 -u<keyword>
2.2.1 -r
2.1?-S<site>
Where:
-t <target_dir> or --target <target_dir>
specifies a directory that contains the boot data. The default is -t /boot.
-l or --list
prints a list of all keyword-value pairs in the zipl environment block.
-s <keyword>=<value> or --set <keyword>=<value>
assigns the specified value to the keyword in the common name space, unless -S is specified. The value can consist of any printable characters, but must not contain functions, such as the new-line symbol. If a keyword does not exist it is added.
The keyword must satisfy the following requirements:
  • Consist of uppercase letters A - Z, digits 0 = 9, and the _ (underscore).
  • Must not begin with a digit.
The maximum number of keyword-value pairs per boot partition is 512.
-u <keyword> or --unset <keyword>
removes the specified keyword from the common name space of the zipl environment block, unless -S is specified.
-r or --reset
removes all keywords from a common name space of the zipl environment block, unless -S is specified. All variables on the command line then resolve to the empty string.
-S <site> or -- site <site>
specifies the site as a numeral in the range 0 to 9. Combine the -S with the -s, -u, or the -r options to manipulate keywords for the specified site.
-h or --help
displays help text.
-v or --version
displays information about the version.

Examples

  • To list the zipl environment block, issue:
    # zipl-editenv -l
    ROOT=/dev/dasda1
    PANIC_TIMEOUT=panic=8
  • To change the value of PANIC_TIMEOUT to panic=9, issue:
    # zipl-editenv -s PANIC_TIMEOUT=panic=9
    
    Use the --list option to check that the keywords and their values are now as expected:
    # zipl-editenv -l
    ROOT=/dev/dasda1
    PANIC_TIMEOUT=panic=9
  • Assume that you have created an environment file with two sites, site 1 and site 2. You then run zipl to prepare the boot device for IPL. The installed environment might look for example like this:
    # zipl-editenv --list
    Common variables:
      VAR_A=A
    Site 1:
      VAR_A=A1
    Site 2:  
      VAR_B=B2
    In this example, the common name space contains keyword VAR_A with the value A, site 1 contains the same keyword with a different value, A1, and site 2 contains keyword VAR_B with the value B2.
    • To define a value for VAR_A at site 2, issue:
      # zipl-editenv --set VAR_A=A2 --site 2
      
    • To add a keyword VAR_C in the common name space, issue:
      # zipl-editenv --set VAR_C=C
    List the environment to see the changes:
    # zipl-editenv --list
    Common variables:
      VAR_A=A
      VAR_C=C
    Site 1:
      VAR_A=A1
    Site 2:
      VAR_A=A2
      VAR_B=B2