Custom Action - Using The Null Patch

Version 5

    Purpose

     

    This document outlines how to use the Nullpatch.exe patch for Custom Actions.

     

    Symptoms


    A Custom Action may include executing a specific command or invoking a custom batch file at specified time(s) during the deployment process. You can specify custom files and actions that occur during every deployment that uses the template, or only for those deployments that install a specific patch or service pack.

     

    Note: A Custom Action will only run if a deployment occurs. If there are no missing patches selected to deploy to a target machine, the Custom Action will NOT occur.

     

    Because a Custom Action will only run when there is a 'missing' patch to deploy with, Shavlik has created a patch called 'Nullpatch.exe'.

     

    This item will allow you to perform 'custom actions' on selected machines.  Create a deployment template with a custom action, then deploy this 'patch' to execute the custom action on the remote machine.  (the patch associated with this item does not install anything on the target systems).

     

    Steps

     

    1. Create a New Deployment Template; enter a Name for the Template, and Save it.
      1. Alternatively - open an existing Deployment Template you wish to modify.
    2. Click the Custom Actions tab.
    3. Click the New option.

    1-template.png

     

    4. The Custom Actions window will now be open
    2-custacti.png

    1. Specify what patch deployment action will trigger the command.
    2. If in Step 1 you indicate that only the deployment of specific patches or service packs will trigger the command, specify those files here.
    3. Specify when during the patch deployment process the command will be triggered. The choices will depend on the selection made in Step 1.
      • If the action is to be applied to all deployments that use this template, then the choices are:
        • Before any patches are installed
        • Before each patch is installed
        • After each patch is installed
        • After all patches are installed (but before reboot)
        • After reboot

    This allows you to perform actions such as custom logging.

    • If the action is to be applied to a specific patch or service pack, then the choices are:
    • Before any patches are installed
    • Before the patch/service pack file selected in Step 2 is installed
    • After the patch/service pack file selected in Step 2 is installed
    • After all patches are installed (but before reboot)
    • After reboot

    This allows you to perform actions only when pushing a specific patch or service pack to a target machine using this deployment template.

    • You can also choose to push a custom file (such as a custom batch file or custom executable file) to the target machines as part of the deployment by selecting Push File.
    1. Specify the file to push or the command to execute. The command will be inserted into the patch installation batch file at the point(s) specified in Step 3. If Step 3 specifies Push Filethen the specified file will be copied to the target machines and put in the ProPatches\Installdirectory. You can reference the file in other custom actions by specifying %PATHTOFIXES%Install\file_name.

     

    Example 1: If you push the file myFile.exe, you can execute that file with the following custom command: %PATHTOFIXES%Install\myFile.exe.

     

    Example 2: If you push the batch file myCommands.batto the target machines, you can invoke the batch file at the appropriate point in the deployment with the following custom command:
    call
    %PATHTOFIXES%Install\myCommands.bat.

     

    Related Documents

     

     

    Affected Product(s)

     

    Protect Version: All