This chapter provides information and procedures for creating your own custom rule and probe keywords.Probe Keywords Creating a custom_probes File Validating the custom_probes File To understand what a probe keyword is, you first need to recall what a rule keyword is. A rule keyword is a predefined lexical unit or word that describes a general system attribute, such as host name, hostname, or memory size, memsize. Rule keywords and the values that are associated with them enable you to match a system that has the same attribute to a profile. This match of a system's attributes defines how the Solaris software is to be installed on each system in the group. Custom JumpStart environment variables, which you use in begin and finish scripts, are set on demand. For example, information about which operating system is already installed on a system is only available in SI_INSTALLED after the installed rule keyword is used.In some situations, you might need to extract the same information in a begin or finish script for a purpose other than to match a system and run a profile. Probe keywords provide the solution. Probe keywords extract attribute information and remove the need for you to set up a matching condition and run a profile.For a list of probe keywords and values, see Probe Keywords and Values. The rule and probe keywords that are described in Rule Keywords and Values and Probe Keywords and Values might not be precise enough for your needs. You can define your own custom rule or probe keywords by creating a custom_probes file.The custom_probes file is a Bourne shell script that contains two types of functions. You must save the custom_probes file in the same JumpStart directory where you saved the rules file. The two types of functions that you can define in a custom_probes file are as follows:Probe – Gathers the information you want or does the actual work and sets a corresponding SI_ environment variable that you define. Probe functions become probe keywords. Comparison – Calls a corresponding probe function, compares the output of the probe function, and returns 0 if the keyword matches or 1 if the keyword does not match. Comparison functions become rule keywords. The custom_probes file can contain any valid Bourne shell command, variable, or algorithm.You can define probe and comparison functions that require a single argument in the custom_probes file. When you use the corresponding custom probe keyword in the rules file, the argument after the keyword is interpreted (as $1).When you use the corresponding custom rule keyword in the rules file, the arguments are interpreted in sequence. The sequence starts after the keyword and ends before the next && or begin script, whichever comes first. The custom_probes file must meet the following requirements: Have the name custom_probes Have root as its owner Be executable and have permissions set to 755 Contain at least one probe function and one corresponding comparison function To improve clarity and organization, define all probe functions first, at the top of the file, followed by all comparison functions. The name of a probe function must begin with probe_. The name of a comparison function must begin with cmp_.Functions that begin with probe_ define new probe keywords. For example, the function probe_tcx defines the new probe keyword tcx. Functions that begin with cmp_ define new rule keywords. For example, cmp_tcx defines the new rule keyword tcx. Use a text editor to create a Bourne shell script text file. Name the file custom_probes. In the custom_probes text file, define your probe and comparison functions.You can define probe and comparison functions that require arguments in the custom_probes file. When you use the corresponding custom probe keyword in the rules file, the arguments after the keyword are interpreted in sequence (as $1, $2, and so on). When you use the corresponding custom rule keyword in the rules file, the arguments are interpreted in sequence. The sequence starts after the keyword and ends before the next && or begin script, whichever comes first. Save the custom_probes file in the JumpStart directory next to the rules file. Ensure that root owns the rules file and that the permissions are set to 644. You can find additional examples of probe and comparison functions in the following directories:/usr/sbin/install.d/chkprobe on a system that has the Solaris software installed /Solaris_11/Tools/Boot/usr/sbin/install.d/chkprobe on the Solaris Operating System DVD or on the Solaris Software - 1 CD The following custom_probes file contains a probe and comparison function that tests for the presence of a TCX graphics card.#!/bin/sh # # custom_probe script to test for the presence of a TCX graphics card. # # # PROBE FUNCTIONS # probe_tcx() { SI_TCX=`modinfo | grep tcx | nawk '{print $6}'` export SI_TCX } # # COMPARISON FUNCTIONS # cmp_tcx() { probe_tcx if [ "X${SI_TCX}" = "X${1}" ]; then return 0 else return 1 if } The following example rules file shows the use of the probe keyword that is defined in the preceding example, tcx. If a TCX graphics card is installed and found in a system, profile_tcx is run. Otherwise, profile is run.Always place probe keywords at or near the beginning of the rules file. This placement ensures that the keywords are read and run before other rule keywords that might rely on the probe keywords. probe tcx tcx tcx - profile_tcx - any any - profile - Before you can use a profile, rules, and custom_probes file, you must run the check script to validate that the files are set up correctly. If all profiles, rules, and probe and comparison functions are correctly set up, the rules.ok and custom_probes.ok files are created. Table 5–1 describes what the check script does. Stage Description 1 check searches for a custom_probes file. 2 If the file exists, check creates the custom_probes.ok file from the custom_probes file, removes all comments and blank lines, and retains all Bourne shell commands, variables, and algorithms. Then, check adds the following comment line at the end: # version=2 checksum=num Verify that the check script is located in the JumpStart directory.The check script is in the Solaris_11/Misc/jumpstart_sample directory on the Solaris Operating System DVD or on the Solaris Software - 1 CD. Change to the JumpStart directory. Run the check script to validate the rules and custom_probes files. $ ./check -p path -r file_namep pathValidates the custom_probes file by using the check script from the Solaris software image for your platform instead of the check script from the system you are using. path is the image on a local disk or a mounted Solaris Operating System DVD or Solaris Software - 1 CD.Use this option to run the most recent version of check if your system is running a previous version of Solaris. r file_nameSpecifies a file name other than the one that is named custom_probes. By using the r option, you can test the validity of a set of functions before integrating the functions into the custom_probes file. As the check script runs, the script reports the validity of the rules and custom_probes files and each profile. If no errors are encountered, the script reports: “The custom JumpStart configuration is ok” and creates the rules.ok and custom_probes.ok files in the JumpStart directory. Determine if the custom_probes.ok file is executable.If yes, go to Step 5. If no, type the following command.# chmod +x custom_probes Ensure that root owns the custom_probes.ok file and that the permissions are set to 755.