Sample job customization

This section provides information about customizing the sample Altiris jobs provided with the ServerGuide Scripting Toolkit, Linux Edition that perform functions such as configuring PRAID, ASU, and Fibre settings.

Each sample job provided through the Altiris Deployment Solution console that contains customizable settings begins with a task that sets all variables for the job. This task is labeled Customize Job Variables. The variables that you can modify are contained within a block that is similar to the following:

[User_Customizable_Variables]

Variables

[End_User_Customizable_Variables]

You cannot modify variables outside this block. When you modify a job, it is a good practice to create a copy of the job and modify the copy, rather than the original job.

Table 1 provides a list of the variables in the sample Altiris jobs that you can customize. Note that all values for variables must be enclosed within quotation marks.

Table 1. Customizable variables in Altiris sample jobs
Variable	Description
[PRAID Settings]
`TK_pRAID_File`	Specifies the PRAID policy file to be used for the job. Default:: Varies per job, see next section.
`TK_pRAID_Flags`	Specifies any additional flags to be passed to the PRAID utility. Default: `-r`
[Fibre Settings]
`TK_FIBRE_COUNT`	Specifies the number of HBA ports to configure. Valid values are 1–`n`, where `n` is the number of HBA ports available. This variable affects the use of the following variables: `TK_FIBRE_N_HBA_ID` `TK_FIBRE_N_BOOT_DISABLE` `TK_FIBRE_N_BOOT_PRIM` `TK_FIBRE_N_BOOT_ALT1` `TK_FIBRE_N_BOOT_ALT2` `TK_FIBRE_N_BOOT_ALT3` Where `N` is the HBA number to be configured. Note: You must complete one of each of these variables for every HBA port you configure. So if `TK_FIBRE_COUNT=2`, you must complete one set of these variables for the first port and one for the second.
`TK_FIBRE_N_HBA_ID`	Identifies the Qlogic/Emulex HBA to be configured, where `N` is the HBA number to be configured. Valid values are: `hba_instance` The instance number of an HBA port. Valid values are integers from 0 to `N-1`, where `N` is the number of HBAs in the system. For example, to configure HBA instance 0:`TK_FIBRE_1_HBA_ID=0` `hba_wwpn` The World Wide Port Name of an HBA port, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxxxx`. For example, to configure HBA: 90-87-AA-BB-65-34-BB-E0: `TK_FIBRE_1_HBA_ID= 90-87-AA-BB-65-34-BB-E0` Default: `0`
`TK_FIBRE_N_HBA_ID`	Identifies the Brocade HBA to be configured, where `N` is the HBA number to be configured. Valid values are: `hba_instance` The instance number of an HBA port. Valid format is `N/P`, where `N` is the adapter number from 1 to `N`, and `P` is the port number from 0 to `p-1`. For example, to configure HBA instance 0: `TK_FIBRE_1_HBA_ID=1/0` `hba_wwpn` The World Wide Port Name of an HBA port, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxxxx`. For example, to configure HBA: 90-87-AA-BB-65-34-BB-E0: `TK_FIBRE_1_HBA_ID= 90-87-AA-BB-65-34-BB-E0` Default: `0`
`TK_FIBRE_N_BOOT_DISABLE`	Disable the selected current boot device settings on the specified HBA port, where `N` is the HBA number to be configured. Valid values are No Does not clear or disable any boot settings. All Disables the primary and all alternate boot settings – Prim, Alt1, Alt2, and Alt3. Prim Disables only the primary boot setting. Alt1 Disables the Alternative 1 boot setting. Alt2 Disables the Alternative 2 boot setting. Alt3 Disables the Alternative 3 boot setting. Default: `No`
`TK_FIBRE_N_BOOT_PRIM = target_wwnn target_wwpn lun_id`	Defines the primary boot target settings, where `N` is the HBA number to be configured, and: `target_wwnn` is the World Wide Node Name of a device, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxx`. `target_wwpn` is the World Wide Port Name of a device, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxx`. `lun_id` is the Logical Unit Number of a device. Default: `0 0 0` Example: `TK_FIBRE_1_BOOT_PRIM= BB-CC-AA-BB-65-34-BB-F1 BB-CC-AA-BB-FF-34-BB-F1 9`
`TK_FIBRE_N_BOOT_ALT1 = target_wwnn target_wwpn lun_id`	Configures the operating system to use the indicated target as the first alternate boot device, where `N` is the HBA number to be configured, and `target_wwnn` is the World Wide Node Name of a device, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxx`. `target_wwpn` is the World Wide Port Name of a device, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxx`. `lun_id` is the Logical Unit Number of a device. Default: blank Example: `TK_FIBRE_1_BOOT_ALT1= BB-CC-AA-BB-65-34-BB-FD BB-CC-AA-BB-FF-40-BB-F1 5`
`TK_FIBRE_N_BOOT_ALT2 = target_wwnn target_wwpn lun_id`	Configures the operating system to use the indicated target as the second alternate boot device, where `N` is the HBA number to be configured, and `target_wwnn` is the World Wide Node Name of a device, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxx`. `target_wwpn` is the World Wide Port Name of a device, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxx`. `lun_id` is the Logical Unit Number of a device. Default: blank Example: `TK_FIBRE_1_BOOT_ALT2= BB-CC-AA-BB-65-34-BB-FD BB-CC-AA-BB-FF-40-BB-F1 5`
`TK_FIBRE_N_BOOT_ALT3 = target_wwnn target_wwpn lun_id`	Configures the operating system to use the indicated target as the third alternate boot device, where `N` is the HBA number to be configured, and `target_wwnn` is the World Wide Node Name of a device, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxx`. `target_wwpn` is the World Wide Port Name of a device, in the format `xx-xx-xx-xx-xx-xx-xx-xx` or `xxxxxxxxxxxxxx`. `lun_id` is the Logical Unit Number of a device. Default: blank Example: `TK_FIBRE_1_BOOT_ALT3= BB-CC-AA-BB-65-34-BB-FD BB-CC-AA-BB-FF-40-BB-F1 5`
[ASU Settings]
`TK_ASU_File`	Specifies the file to be used for a Capture System Settings or Deploy System Settings operation. If you are capturing system settings, they will be written to a file with this name. If you are deploying system settings, they will be read from this file. Default: /sgdeploy/sgtklinux/ini/asu/$(BIOS_Build_Level0:2)/asu_capture
`TK_ASU_Mode`	Specifies the ASU mode being used. This value is used with the asu command and the value of the `TK_ASU_File` variable to create a complete ASU command. Valid values are: `save`, `replicate`, and `batch`.
`TK_ASU_Flags`	Specifies additional flags for the current mode. The default value is –group-bios.
[NOS Installation Settings]
`TK_DISTRO_TYPE`	Specifies the Linux distribution to be installed. Valid values are: `RHEL`, `SLES`, and `VMWARE`
`TK_DISTRO_VERSION`	Specifies the version of the operating system indicated by `TK_DISTRO_TYPE`. Valid values correspond to the supported versions of the supported operating systems. Note: The version number must be a valid and supported version of the Linux distribution specified by TK_DISTRO_TYPE.
`TK_DISTRO_PATH`	Specifies the fully qualified URL for the location of the network share where the operating system files are located. Supported protocols are FTP, HTTP, and NFS. Default: `ftp://$TK_Altiris_IP/sgdeploy/os/osfolder`
`TK_DISTRO_CFG`	Specifies the unattended answer file to be used for the operating system installation. This file must be formatted as a kickstart or autoyast file, depending on the distribution being deployed. Default: `./sgdeploy/sgtklinux/altiris/answerfiles/answerfile`
`TK_DISTRO_KPARAM`	Specifies additional kernel parameters to be used for the deployment, such as VNC parameters or a static IP address. Default: `none`
`TK_DISTRO_NIC_PORT`	Specifies a Network Interface Card (NIC) to be used for the installation, if the NIC is different than the one used for the pre-installation execution environment (PXE) boot. If no NIC is specified, the NIC used for PXE boot will be used for the installation, by using the bootif method. Note: This variable is not valid for VMware ESX Server. To indicate the network device for VMware ESX Server, edit the network section of the VMware kickstart file.
[Director Agent Settings]
`TK_DirAgent_DirectorAgent`	Specifies the location of the IBM Director Agent application files on the source server. Valid values are: `dirlin` A user-supplied directory in the sgdeploy/apps directory Default:`dirlin`
[UXSP Settings]
`TK_UXSP_UpdateXpressSystemPacks`	Specifies the location of the UpdateXpress System Packs on the source server. Valid values are: `uxsp` a user-specified directory in the sgdeploy/updates directory Default: `uxsp`