MDT Scripting: Creating custom scripts Getting Started

Although MDT is very powerful, there will still be times when dealing with complex tasks that you will require a custom script. Fortunately you can use your own custom VB scripts in MDT as a task sequence step by calling the command line:

cscript.exe "%SCRIPTROOT%\CustomScripts\MyScript.wsf"

It is however, best practice (and to save time) to use the MDT Custom Script Template to create your custom scripts for use within task sequences. This also applies to Zero-Touch custom scripting in SCCM. The MDT Custom Script Template is a WSF(Windows Scripting Host) script that calls functions (pre-written subroutines) in another script called ZTIUtility.vbs. The template is below:

<job id="Z-Sample">
<script language="VBScript" src="ZTIUtility.vbs"/>
<script language="VBScript">

' //***************************************************************************
' // ***** Script Header *****
' //
' // Solution: Solution Accelerator for Microsoft Deployment
' // File: Z-Sample.wsf
' //
' // Purpose: Template
' //
' // Usage: cscript Z-Sample.wsf [/debug:true]
' //
' // Customer Build Version: 1.0.0
' // Customer Script Version: 1.0.0
' // Customer History:
' //
' // ***** End Header *****
' //***************************************************************************

'//----------------------------------------------------------------------------
'//
'// Global constant and variable declarations
'//
'//----------------------------------------------------------------------------

Option Explicit

Dim iRetVal

'//----------------------------------------------------------------------------
'// End declarations
'//----------------------------------------------------------------------------

'//----------------------------------------------------------------------------
'// Main routine
'//----------------------------------------------------------------------------

On Error Resume Next
iRetVal = ZTIProcess
ProcessResults iRetVal
On Error Goto 0

'//---------------------------------------------------------------------------
'//
'// Function: ZTIProcess()
'//
'// Input: None
'//
'// Return: Success - 0
'// Failure - non-zero
'//
'// Purpose: Perform main ZTI processing
'//
'//---------------------------------------------------------------------------
Function ZTIProcess()

     iRetVal = Success

     ZTIProcess = iRetval

     '!!!!!!!!!!!   INSERT YOUR CODE HERE   !!!!!!!!!!!!

End Function

</script>
</job>

This is nothing new, people have been scripting in MDT and SCCM using this template with the ZTIUtility for a while now. Ben Hunter has an old article on this here. However, some customers that I have encountered recently have not been aware of this so hopefully this article will raise awareness for them and also for my regular blog readers.

Why do this? Well, the ZTIUtility.vbs is full of pre-written functions designed to manage files and folders, registry settings and it can use MDT’s collected variables etc. so you don’t have to waste time designing and generating your own custom code. Plus, there are fantastic logging features available to help with monitoring and debugging.

How does it work? Simply copy the template and save it with a .WSF extension then add custom code at the INSERT YOUR CODE HERE section that calls functions. Here you can call in the ZTIUtility subroutines.

You typically save the script in the scripts folder of your deployment share with a ZTI prefix. Next, create a Run command line task sequence step to call the script in your deployment. eg.

cscript.exe "%SCRIPTROOT%\ZTIMyScript.wsf"

Over the next few blogs, I’m going to explain further and write and post some scripting examples showing how to use the template to tackle everyday real world deployment tasks.