Scripts - wiseDATAman

Update User Attributes from CSV File

Fri, 16 Mar 2012 00:00:45 +0000

Update active directory user attributes from a CSV File. (See Notes section for additional information and instructions)
Notes

Introduction

This script can be used to update Active Directory User attributes from a CSV file. One column in the CSV file is used to match rows in the CSV file to user accounts in Active Directory and the other columns are used to update attributes. Normally the Pre-Windows 2000 username (sAMAccountName) attribute is used to match rows in the CSV file to user accounts in Active Directory, but you can easily modify the script to use a different attribute if required. For example, you might want to identify the user account you want to update in the CSV file by email address (mail attribute) rather than username. As an alternative to this script, you might also to consider using the free Bulk AD Users application available on this website. Bulk AD Users supports updating users via CSV file and it includes some other tools for updating users accounts such as the Edit In Excel and Bulk Modify features. The Bulk AD Users application can make it easier for you to apply the update and it also produces an XML log file of the update which can be used to rollback changes. That’s not to say that Bulk AD Users is a complete replacement for this script as the script allows you to customise the code for your own requirements, and it can also be automated via task manager if required.

Bulk Update Considerations

There is always an element of risk involved in performing bulk updates to Active Directory. Please be sure to test updates in a QA environment before applying them to your live domain. Also, it’s a good idea to have a plan of action prepared should something go wrong with the update. Taking a backup of your Active Directory database is a sensible precaution, and it also pays to be familiar with backup and restore techniques. If you have a large domain or a domain that is connected over slow WAN links, you might also need to consider the impact of replication traffic when performing bulk updates. Bulk updates can save an enormous amount of time and they normally run very smoothly if planned correctly.

Setup

The first step in updating user accounts from a CSV file is to produce a valid CSV input file for the script. A CSV file is simply a text file containing rows and columns of data like a spreadsheet and they can be read and written to by spreadsheet applications like Microsoft Excel. There is normally a way to extract data from databases into CSV text files. It’s also possible to produce a text file manually by using an application such as notepad. See here for more information on producing CSV files. As well as taking care to ensure that the CSV file you have produced is valid, you also need to ensure that the CSV file includes a header row. The header row is used by the script to identity the column names and the column names should correspond to the attribute names used by Active Directory. The attribute names are not always obvious, so please take care to ensure that you are using the correct names. For example, the surname attribute is “sn” and the first name attribute is “givenName”. As mentioned previously, the username (pre windows 2000) is used by default to match rows in the CSV file to the user accounts in Active Directory. This attribute name is “sAMAccountName” and must be included in your CSV file (unless you plan to use a different search attribute). If you don’t want to edit the script, the CSV file should be called “usermod.csv” and it should be located on the root of the “C:\” drive. If you want to use a different filename or location, edit the _strCSVFolde_r and strCSVFile attributes in the setup section of the script. Change the strSearchAttribute if you want to use a different attribute for matching rows in the CSV file to users in Active Directory (e.g. userPrincipalName or mail attribute). The attribute you choose for the strSearchAttribute should be unique as the script expects a maximum of 1 user to be returned for any attribute value. If multiple users are found with the same attribute value, no user accounts will be updated. The configuration of the script and the CSV file is now complete. The script is designed to run in cscript mode (described in this article). If you double click the script, the script will run in wscript mode - the script will work ok, but you will get a lot of annoying prompts. To run in cscript mode, open a command prompt and change the current directory to the one that contains the script. Use the following command to run the script: cscript csv_user_update.vbs The results of the script will be output to the console window. If you prefer to have the results stored in a text file, use the following command instead: cscript csv_user_update.vbs » results.txt

Extracting CSV Data From Active Directory

If you would like to extract data as a CSV file from Active Directory as a base for your update, please refer to the scripts below:

Extract User Data To a CSV File

Extract User Data To a CSV File (Inc Terminal Services Attributes)

Custom Attribute Handling

The script should support most single-valued attributes by default. In addition, special handling has been added for the following attributes:

Attribute Name	Description
cn	This attribute is the "Name" column that is shown in Active Directory Users & Computers and it's a standard attribute in AD. The cn (common name) forms part of an objects distinguished name. This attribute must be unique within it's parent container (organizational unit). This attribute can be read the same as any other attribute, but to change the value you need to use the "MoveHere" method.
TerminalServicesProfilePath	Terminal Services attributes are stored in the "userparameters" attribute in Active Directory. Modifying this attribute directly isn't recommended, but it is possible to modify these attributes via the IADsTSUserEx interface. The TsUserEx.dll is required to modify these values, otherwise you will get a "Object doesn't support this property or method" error. To fix this you will need to install the Windows 2000/2003 Administration Tools Pack.
TerminalServicesHomeDirectory
TerminalServicesHomeDrive
AllowLogon
Password	Microsoft doesn't provide any access to user passwords stored in Active Directory via ADSI, either in encrypted or unencrypted format. It is possible to change a password by calling the "SetPassword" method though. The script won't output the previous value as it does with other attributes. Note: Please take care to ensure passwords meet length and complexity requirements.
Manager_sAMAccountName	The manager attribute in active directory requires a distinguished name. e.g. CN=David.Wiseman,OU=MyUsers,DC=WiseSoft,DC=co,DC=UKTo make this attribute easier to modify, you can specify "Manager_sAMAccountName" as the attribute name in the CSV header instead of "manager". This allows you to use the username (Pre Windows 2000) instead of the manager's distinguished name. e.g.David.Wiseman

You might want to refer to the Active Directory Schema Guide to help identify the correct attribute names for other attributes. Note: Bulk AD Users provides better support for multi-valued attributes if required.

Troubleshooting

Provider cannot be found error

The script uses the Microsoft.Jet.OLEDB.4.0 provider. If you are using x64, you will need to use the 32bit script host for this provider to be available. To do this, open a command prompt and navigate to the “SysWow64” folder in your Windows directory. e.g.
C:\Windows\SysWOW64\ You can now run cscript from this location, passing the full location of your script file. e.g. cscript “C:\update_users_csv.vbs”

Data Not Imported as Expected

This script uses the Microsoft.Jet.OLEDB.4.0 provider for parsing the CSV file. Sometimes the data type gets mis-interpreted and the data is not imported as expected. An example of this is where you are updating the telephoneNumber attribute and your telephone numbers start with a leading zero. The provider is likely to interpret this as a number rather than a string which results in the leading zeros getting truncated. To get around this issue, you can create a schema.ini file. If you have a CSV file consisting only of sAMAccountName and telephoneNumber columns, your schema.ini file might look something like this: [usermod.csv]
ColNameHeader=True
Format=CSVDelimited
Col1=sAMAccountName Text
Col2=telephoneNumber Text For more information on schema.ini files, please refer to this article.

Version History

Version	Date	Notes
1.1	2009-11-19	Changed script to use CSV header Added support for terminal services attributes Added support for changing passwords
1.0	2008-01-21	Initial release.

Update AD User Accounts from CSV


 1
 2
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287


OPTION EXPLICIT ' Variables must be declared
' *************************************************
' * Instructions
' *************************************************

' Edit the variables in the "Setup" section as required.
' Run this script from a command prompt in cscript mode.
' e.g. cscript usermod.vbs
' You can also choose to output the results to a text file:
' cscript usermod.csv >> results.txt

' *************************************************
' * Constants / Decleration
' *************************************************
CONST adOpenStatic = 3
CONST adLockOptimistic = 3
CONST adCmdText = &H0001
CONST ADS_PROPERTY_CLEAR = 1

DIM strSearchAttribute 
DIM strCSVHeader, strCSVFile, strCSVFolder
DIM strAttribute, userPath
DIM userChanges
DIM cn,cmd,rs
DIM objUser
DIM oldVal, newVal
DIM objField
DIM blnSearchAttributeExists
' *************************************************
' * Setup
' *************************************************

' The Active Directory attribute that is to be used to match rows in the CSV file to
' Active Directory user accounts. It is recommended to use unique attributes.
' e.g. sAMAccountName (Pre Windows 2000 Login) or userPrincipalName
' Other attributes can be used but are not guaranteed to be unique. If multiple user 
' accounts are found, an error is returned and no update is performed.
strSearchAttribute = "sAMAccountName" 'User Name (Pre Windows 2000)

' Folder where CSV file is located 
strCSVFolder = "C:\"
' Name of the CSV File
strCSVFile = "usermod.csv"

' *************************************************
' * End Setup
' *************************************************

' Setup ADO Connection to CSV file
SET cn = CREATEOBJECT("ADODB.Connection")
SET rs = CREATEOBJECT("ADODB.Recordset")

cn.Open "Provider=Microsoft.Jet.OLEDB.4.0;" & _
 "Data Source=" & strCSVFolder & ";" & _
 "Extended Properties=""text;HDR=YES;FMT=Delimited"""

rs.Open "SELECT * FROM [" & strCSVFile & "]", _
 cn, adOpenStatic, adLockOptimistic, adCmdText

' Check if search attribute exists
blnSearchAttributeExists=false
FOR EACH objField in rs.Fields
	IF UCASE(objField.Name) = UCASE(strSearchAttribute) THEN
		blnSearchAttributeExists=true
	END IF
NEXT
		
IF blnSearchAttributeExists=false THEN
	MSGBOX "'" & strSearchAttribute & "' attribute must be specified in the CSV header." & _
		VbCrLf & "The attribute is used to map the data the csv file to users in Active Directory.",vbCritical
	wscript.quit
END IF

' Read CSV File
DO Until rs.EOF
	' Get the ADsPath of the user by searching for a user in Active Directory on the search attribute
	' specified, where the value is equal to the value in the csv file.
	' e.g. LDAP://cn=user1,cn=users,dc=wisesoft,dc=co,dc=uk
	userPath = getUser(strSearchAttribute,rs(strSearchAttribute))
	' Check that an ADsPath was returned
	IF LEFT(userPath,6) = "Error:" THEN
		wscript.echo userPath
	ELSE
		wscript.echo userPath
		' Get the user object
		SET objUser = GETOBJECT(userpath)
		userChanges = 0
		' Update each attribute in the CSV string
		FOR EACH objField in rs.Fields
			strAttribute = objField.Name
			oldval = ""
			newval = ""
			' Ignore the search attribute (this is used only to search for the user account)
			IF UCASE(strAttribute) <> UCASE(strSearchAttribute) AND UCASE(strAttribute) <> "NULL" THEN
				newVal = rs(strAttribute) ' Get new attribute value from CSV file
				IF ISNULL(newval) THEN
					newval = ""
				END IF
				' Special handling for common-name attribute. If the new value contains
				' commas they must be escaped with a forward slash.
				IF strAttribute = "cn" THEN
					newVal = REPLACE(newVal,",","\,")
				END IF
				' Read the current value before changing it
				readAttribute strAttribute
								
				' Check if the new value is different from the update value
				IF oldval <> newval THEN
					wscript.echo "Change " & strAttribute & " from '" & oldVal & "' to '" & newVal & "'"
					' Update attribute
					writeAttribute strAttribute,newVal
					' Used later to check if any changes need to be committed to AD
					userChanges = userChanges + 1
				END IF
			END IF
		NEXT
		' Check if we need to commit any updates to AD
		IF userChanges > 0 THEN
			' Allow script to continue if an update fails
			ON ERROR RESUME NEXT
			err.clear
			' Save Changes to AD
			objUser.setinfo
			' Check if update succeeded/failed
			IF err.number <> 0 THEN
				wscript.echo "Commit Changes: Failed. " & err.description
				err.clear
			ELSE
				wscript.echo "Commit Changes: Succeeded"
			END IF
			ON ERROR GOTO 0
		ELSE
			wscript.echo "No Changes"
		END IF
		
	END IF

 	userPath = ""
 rs.MoveNext
LOOP

' Cleanup
rs.close
cn.close
' *************************************************
' * End of script
' *************************************************

' *************************************************
' * Functions
' *************************************************
' Reads specified attribute and sets the value for the oldVal variable
SUB readAttribute(BYVAL strAttribute)
	SELECT CASE LCASE(strAttribute) 
		CASE "manager_samaccountname" 
			' special handling to allow update of manager attribute using sAMAccountName (UserName)
			' instead of using the distinguished name
			DIM objManager, managerDN
			' Ignore error if manager is null
			ON ERROR RESUME NEXT
			managerDN = objUser.GET("manager")
			ON ERROR GOTO 0
			IF managerDN = "" THEN
				oldVal=""
			ELSE
				SET objManager = GETOBJECT("LDAP://" & managerDN)
				oldVal = objManager.sAMAccountName
				SET objManager=Nothing
			END IF
		CASE "terminalservicesprofilepath"
			'Special handling for "TerminalServicesProfilePath" attribute
			oldVal=objUser.TerminalServicesProfilePath
		CASE "terminalserviceshomedirectory"
			'Special handling for "TerminalServicesHomeDirectory" attribute
			oldVal = objUser.TerminalServicesHomeDirectory
		CASE "terminalserviceshomedrive"
			'Special handling for "TerminalServicesHomeDrive" attribute
			oldVal=objUser.TerminalServicesHomeDrive
		CASE "allowlogon"
			' Special handling for "allowlogon" (Terminal Services) attribute
			' e.g. 1=Allow, 0=Deny
			oldVal=objUser.AllowLogon
		CASE "password"
			' Password can't be read, just return ****
			oldVal="****"
		CASE ELSE
			ON ERROR RESUME NEXT ' Ignore error if value is null
			' Get old attribute value
			oldVal = objUser.GET(strAttribute)
			ON ERROR GOTO 0
	END SELECT
END SUB
' updates the specified attribute
SUB writeAttribute(BYVAL strAttribute,newVal)
	SELECT CASE LCASE(strAttribute)
		CASE "cn" 'Special handling required for common-name attribute
			DIM objContainer
			SET objContainer = GETOBJECT(objUser.Parent)

			ON ERROR RESUME NEXT
			objContainer.MoveHere objUser.ADsPath,"cn=" & newVal

			' The update might fail if a user with the same common-name exists within
				' the same container (OU)
			IF err.number <> 0 THEN
				wscript.echo "Error changing common-name from '" & oldval & "' to '" & newval & _
						 "'. Check that the common-name is unique within the container (OU)"
				err.clear
			END IF
			ON ERROR GOTO 0
		CASE "terminalservicesprofilepath"
			'Special handling for "TerminalServicesProfilePath" attribute
			objUser.TerminalServicesProfilePath=newVal
		CASE "terminalserviceshomedirectory"
			'Special handling for "TerminalServicesHomeDirectory" attribute
			objUser.TerminalServicesHomeDirectory=newVal
		CASE "terminalserviceshomedrive"
			'Special handling for "TerminalServicesHomeDrive" attribute
			objUser.TerminalServicesHomeDrive=newVal
		CASE "allowlogon" 
			' Special handling for "allowlogon" (Terminal Services) attribute
			' e.g. 1=Allow, 0=Deny
			objUser.AllowLogon=newVal
		CASE "password"
			' Special handling for setting password
			objUser.SetPassword newVal
		CASE "manager_samaccountname" 
			' special handling to allow update of manager attribute using sAMAccountName (UserName)
			' instead of using the distinguished name
			IF newVal = "" THEN
				objUser.PutEx ADS_PROPERTY_CLEAR, "manager", NULL
			ELSE
				DIM objManager, managerPath, managerDN
				managerPath = GetUser("sAMAccountName",newVal)
				IF LEFT(managerPath,6) = "Error:" THEN
					wscript.echo "Error resolving manager DN:" & managerPath
				ELSE
					SET objManager = GETOBJECT(managerPath)
					managerDN = objManager.GET("distinguishedName")
					SET objManager = NOTHING
					objUser.Put "manager",managerDN
				END IF
			END IF	
		CASE ELSE ' Any other attribute
			' code to update "normal" attribute
			IF newVal = "" THEN
				' Special handling to clear an attribute
				objUser.PutEx ADS_PROPERTY_CLEAR, strAttribute, NULL
			ELSE
				objUser.put strAttribute,newVal
			END IF
	END SELECT
END SUB

' Function to return the ADsPath of a user account by searching
' for a particular attribute value
' e.g. LDAP://cn=user1,cn=users,dc=wisesoft,dc=co,dc=uk
FUNCTION getUser(BYVAL strSearchAttribute,strSearchValue)
	DIM objRoot
	DIM getUserCn,getUserCmd,getUserRS

	ON ERROR RESUME NEXT
	SET objRoot = GETOBJECT("LDAP://RootDSE")

	SET getUserCn = CREATEOBJECT("ADODB.Connection")
	SET getUserCmd = CREATEOBJECT("ADODB.Command")
	SET getUserRS = CREATEOBJECT("ADODB.Recordset")

	getUserCn.open "Provider=ADsDSOObject;"
	
	getUserCmd.activeconnection=getUserCn
	getUserCmd.commandtext="<LDAP://" & objRoot.GET("defaultNamingContext") & ">;" & _
			"(&(objectCategory=person)(objectClass=user)(" & strSearchAttribute & "=" & strSearchValue & "));" & _
			"adsPath;subtree"
	
	SET getUserRs = getUserCmd.EXECUTE

	IF getUserRS.recordcount = 0 THEN
		getUser = "Error: User account not found"
	ELSEIF getUserRS.recordcount = 1 THEN
 	getUser = getUserRs(0)
	ELSE
		getUser = "Error: Multiple user accounts found. Expected one user account."
	END IF
	
	getUserCn.close
END FUNCTION

SQL Server Database Restore Utility

Thu, 11 Jun 2009 00:00:00 +0000

This script is a simple utility to allow users to restore SQL Server databases. It’s easier to use for non-DBAs and it provides a method of restoring databases when the management tools are not installed. It’s a good demonstration of a HTA application, but it’s not a intended as a replacement for SQL Server Management Studio. You can only use this utility for simple restore scenarios.A simple utility that allows you to restore SQL Server databases from a backup file.

SQL Database Restore HTA Script
<html><head>
<STYLE TYPE="text/css">
	BODY {font-family: "Verdana, Arial, Helvetica, sans-serif";
		font-size:x-small;
		background-color:#dfe0e5;
	}
	
	table {font-family: "Verdana, Arial, Helvetica, sans-serif";
		font-size:x-small;}

	#RestoreCompleted {
		font-weight:bold;
		color:green;
	}

	#RestoreInProgress {
		font-weight:bold;
		color:blue;
	}

	#RestoreError {
		font-weight:bold;
		color:red;
	}
	#Footer {
	font-weight:bold;
	font-size:10px;
}

</STYLE>

<script language="vbscript" OnLoad="Main()">
	option explicit
	Const HKEY_LOCAL_MACHINE = &H80000002
	Const adVarChar = 200
	Const adParamInput = 1 
	Const intAppWidth = 600
	Const intAppHeight = 280 ' 255

	' Set app size and centre screen on load
	Sub Window_Onload()
		Dim objWMIService,objItem,intHorizontal,intVertical
		Dim intLeft, intTop
 	 	Set objWMIService = GetObject("winmgmts:\\.\root\cimv2")
 
 		For Each objItem in objWMIService.ExecQuery("Select * From Win32_DesktopMonitor")
 		intHorizontal = objItem.ScreenWidth
 		intVertical = objItem.ScreenHeight
 	Next
 	If IsNull(intHorizontal) = False And IsNull(intVertical) = False Then
 	 intLeft = (intHorizontal - intAppWidth) / 2
		 	intTop = (intVertical - intAppHeight) / 2
		 	 	window.moveTo intLeft, intTop
 	 	End If
 	 	window.resizeTo intAppWidth,intAppHeight
 	

		LoadSQLServerInstances()
	End Sub
	
	' Populate list box with local SQL Server instances
	Sub LoadSQLServerInstances()
		Dim strComputer,strKeyPath,strValueName,strValue
		Dim oReg,arrValues, d
		
		strComputer = "."

		Set oReg=GetObject("winmgmts:{impersonationLevel=impersonate}!\\" & _ 
		 strComputer & "\root\default:StdRegProv")
		 
		strKeyPath = "SOFTWARE\Microsoft\Microsoft SQL Server\"
		strValueName = "InstalledInstances"
		oReg.GetMultiStringValue HKEY_LOCAL_MACHINE,strKeyPath, _
		 strValueName,arrValues
		If ISArray(arrValues) = false then
			msgbox "No local SQL Server instances found",vbCritical
			Close()
		end If	
		set d = createobject("Scripting.Dictionary")
		For Each strValue In arrValues
			Dim objOption
		 Set objOption = Document.createElement("OPTION")
			if strValue = "LOCAL" OR strValue="MSSQLSERVER" then
				strValue = "(local)"
			else
				strValue = ".\" & strValue
			end if
			objOption.Text = strValue
			objOption.Value = strValue
			
			if d.Exists(strValue) = false then
				if selInstances.Contains(objOption) = false then
					selInstances.Add(objOption)
				end if
				d.Add strValue,strValue
			end if
		Next
	End Sub
	
	' Prompt user to select backup file
	Sub SelectBackupFile()
		Dim oDLG
		Set oDLG=CreateObject("MSComDlg.CommonDialog") 
		With oDLG
			.DialogTitle="Open"
			.Filter="Backup Files|*.bak|All files|*.*"
			.MaxFileSize=255
			.Flags=.Flags Or &H1000	'FileMustExist (OFN_FILEMUSTEXIST)
			.ShowOpen
			If .FileName<>"" Then
				txtFileName.Value =.FileName
			End If
		End With
		Set oDLG=Nothing
	End Sub
	
	' Prompt user for location of database restore
	Sub SelectRestoreFolder()
		Const MY_COMPUTER = &H11&
		Const WINDOW_HANDLE = 0
		Const OPTIONS = 0
		Dim objShell,objFolder,objFolderItem,strPath

		Set objShell = CreateObject("Shell.Application")
		Set objFolder = objShell.Namespace(MY_COMPUTER)
		Set objFolderItem = objFolder.Self
		strPath = objFolderItem.Path

		Set objShell = CreateObject("Shell.Application")
		Set objFolder = objShell.BrowseForFolder _
				(WINDOW_HANDLE, "Select a folder:", OPTIONS, strPath) 
			 
		If not objFolder Is Nothing Then
			Set objFolderItem = objFolder.Self
			txtRestoreFolder.Value = objFolderItem.Path
		End If

	End Sub
	
	' Show/Hide username/password textbox depending on integrated security option
	Sub ShowAuth()
		if chkIntegrated.Checked = true then
			trUserName.Style.Display = "none"
			trPassword.Style.Display = "none"
			window.resizeTo intAppWidth,intAppHeight
		else
			trUserName.Style.Display = "block"
			trPassword.Style.Display = "block"
			window.resizeTo intAppWidth,intAppHeight + 50
		end if
	End Sub
	
	' Generate connection string for the local database
	Private Function GetConnectionString
		Dim strInstance,strUserName,strPassword
		strInstance = selInstances.Value
		strUserName = txtUserName.Value
		strPassword = txtPassword.Value
		if chkIntegrated.Checked = true then
			GetConnectionString = "Provider=SQLOLEDB.1;Data Source=" & strInstance & ";Integrated Security=SSPI;"
		else
			GetConnectionString = "Provider=SQLOLEDB.1;Data Source=" & strInstance & ";UID=" & strUserName & ";PWD=" & strPassword
		end if
	End Function

	' Check if the specified database name already exists
	Function DatabaseExists(byval dbName)
		
		Dim strSQL,objCn,objCmd,strCn, objRs,pName
		strCn = GetConnectionString()
		strSQL = "SELECT COUNT(*) FROM sysdatabases where name = ?"
		set objCn = CREATEOBJECT("ADODB.Connection")
		set objCmd = CREATEOBJECT("ADODB.Command")
		set pName = objCmd.CreateParameter("@name",advarchar,adParamInput,128,dbname)

		objCmd.Parameters.Append pName
		objCn.Open strCn
		objCmd.ActiveConnection = objCn
		objCmd.CommandText = strSQL
		set objRs = objCmd.Execute
		if objRs(0) = 0 then
			DatabaseExists = false
		else
			DatabaseExists = true
		end if
		objRs.Close
		objCn.Close
	end function
	
	' Perform validations before the restore
	Private Function Validate()
		dim objFSO, strCn, objCn,dbName
		set objFSO=createobject("Scripting.FileSystemObject")
		
		' Check backup file exists
		if NOT objFSO.FileExists(txtFileName.Value) then
			RestoreError.InnerHTML = "File specified does not exist"
			Validate = false
			exit function
		end if
		' Check restore folder exists
		if not objFSO.FolderExists(txtRestoreFolder.Value) then
			RestoreError.InnerHTML = "Folder specified does not exist"
			Validate = false
			exit function
		end if
		err.clear
		on error resume next
		' Check connection to database
		strCn = GetConnectionString
		set objCn = CREATEOBJECT("ADODB.Connection")
		objCn.Open strCn
		objCn.Close
		if err.number <> 0 then
			RestoreError.InnerHTML= "Connection error:" & err.number
			Validate = false
			exit function
		end if
		' Get database name from backup file.
		' Just a quick check that backup file is readable
		GetDatabaseNameFromBackupFile()
		if err.number <> 0 then
			RestoreError.InnerHTML = "Error:" & err.number & " - " & err.description
			Validate = false
			exit function
		end if
		on error goto 0
		' Get database name. 
		dbName = GetDatabaseName()
		' Check if database with same name already exists
		if DatabaseExists(dbName) then
			RestoreError.InnerHTML = "Error: Database '" & dbname & "' already exists"
			Validate = false
			exit function	
		end if
	
		Validate = True
	End Function
	
	' Return database name for restore (either from backup file or user specified name)
	Private Function GetDatabaseName
		if chkDBNameDefault.Checked = True then
			GetDatabaseName = GetDatabaseNameFromBackupFile()
		Else
			GetDatabaseName = txtDBName.Value
		end if
	End Function

	' Retreive database name from backup file
	Private Function GetDatabaseNameFromBackupFile
		Dim strSQL,objCn,objCmd,strCn, objRs,pRestoreFile
		strCn = GetConnectionString()
		strSQL = "RESTORE HEADERONLY FROM DISK = ?"
		set objCn = CREATEOBJECT("ADODB.Connection")
		set objCmd = CREATEOBJECT("ADODB.Command")
		set pRestoreFile = objCmd.CreateParameter("@RestoreFile",advarchar,adParamInput,255,txtFileName.Value)

		objCmd.Parameters.Append pRestoreFile
		objCn.Open strCn
		objCmd.ActiveConnection = objCn
		objCmd.CommandText = strSQL
		set objRs = objCmd.Execute
		GetDatabaseNameFromBackupFile = objRs("DatabaseName")
		objCn.Close
	end function

	' Similar to SQL Server QUOTENAME function
	' Wraps quotes around string and performs escapes
	Private Function QuoteName(byval Value, quoteChar)
		if quotechar = "[" or quotechar = "]" then
			QuoteName = "[" & REPLACE(Value,"]","]]") & "]"
		elseif quoteChar = "'" then
			QuoteName = "'" & REPLACE(Value,"'","''") & "'"
		else
			QuoteName = ""
		end if
	End Function
	
	' Function to get the SQL statement used to perform the DB restore
	Private Function GetRestoreSQL
		Dim strSQL,objCn,objCmd,strCn, objRs,pRestoreFile
		Dim dbName
		dbName = GetDatabaseName()
		strCn = GetConnectionString()
		strSQL = "RESTORE FILELISTONLY FROM DISK = ?"
		set objCn = CREATEOBJECT("ADODB.Connection")
		set objCmd = CREATEOBJECT("ADODB.Command")
		set pRestoreFile = objCmd.CreateParameter("@RestoreFile",advarchar,adParamInput,255,txtFileName.Value)

		objCmd.Parameters.Append pRestoreFile
		objCn.Open strCn
		objCmd.ActiveConnection = objCn
		objCmd.CommandText = strSQL
		on error resume next
		set objRs = objCmd.Execute
		if err.number <> 0 then
			msgbox(err.description & err.number)
			exit function
		end if
		
		Dim strFolder
		strFolder = txtRestoreFolder.Value
		if not RIGHT(strFolder,1) = "\" then
			strFolder = strFolder & "\"
		end if
		
		Dim strRestore,strPath
		while objRs.EOF <> True AND objRs.BOF <> True
			strPath = strFolder + dbname & "_" & objRs("LogicalName")
			if objRs("Type") = "L" then 'LOG
				strPath = strPath & ".ldf"
			elseif objRs("Type") = "S" then 'FILESTREAM
				' Folder don't add extension
			else 'DATA
				if objRs("FileID") = "1" then 'Primary File
					strPath = strPath & ".mdf"
				else
					strPath = strPath & ".ndf"
				end if
			end if
			if LEN(strRestore)> 0 then
				strRestore = strRestore & ", " 
			end if
			strRestore = strRestore & "MOVE N" & QuoteName(objRs("LogicalName"),"'") & " TO " & QuoteName(strPath,"'")
			objRs.MoveNext
		wend
		objCn.Close
		
		strRestore = "RESTORE DATABASE " & QuoteName(dbName,"]") & " FROM DISK=N" & QuoteName(txtFileName.Value,"'") & " WITH FILE=1," & strRestore
		
		GetRestoreSQL = strRestore
	End Function
	
	' Perform database restore
	Sub RestoreDatabase()
		Dim strSQL,strCn, objCn, objCmd

		' Clear any existing error/completed notifications
		RestoreError.InnerHTML = ""
		RestoreCompleted.Style.Display = "none"

		' Perform validation checks prior to restore
		if Validate() = false then
			exit sub
		end if
		' Set restore notification
		RestoreInProgress.Style.Display = "block"
		UpdateScreen 

		' Get SQL for Restore
		strSQL = GetRestoreSQL()
		strCn = GetConnectionString()
	
		set objCn = CREATEOBJECT("ADODB.Connection")
		set objCmd = CREATEOBJECT("ADODB.Command")
		objCn.Open strCn
		objCmd.ActiveConnection = objCn
		objCmd.CommandText = strSQL
		objCmd.CommandTimeout = 0
		on error resume next
		objCmd.Execute
		objCn.Close
		if err.number <> 0 then
			RestoreError.InnerHTML = "Error: " & err.Number & " - " & err.description
		else
			RestoreCompleted.Style.Display = "block"
		end if

		RestoreInProgress.Style.Display = "none"
		
	End Sub

	' Causes a refresh
	Sub UpdateScreen() 
		' this is used to allow screen updates 
		dim CMD, WSHShell 
	
		Set WSHShell = CreateObject("WScript.Shell") 
		CMD = WSHShell.ExpandEnvironmentStrings("%comspec%") 
		WSHShell.run CMD + " /c ", 0, true 
		Set WSHShell = Nothing 
	End Sub 

	' Enables/Disables database name textbox 
	Sub DefaultOptionChanged()
		if chkDBNameDefault.Checked = True then
			txtDBName.Disabled = "Disabled"
			txtDBName.style.backgroundcolor = "#dfe0e5"
		else
			txtDBName.Disabled = ""
			txtDBName.style.backgroundcolor = "#ffffff"
		end if
	End Sub
	
</script>
</head>
<HTA:APPLICATION
	APPLICATIONNAME="Restore Database Utility" ID="RestoreDBHTA" INNERBORDER="no" >
<body leftmargin=30 topmargin=20 rightmargin=30>
<table>
<tr>
<td>Backup File:</td><td><input id="txtFileName" style="width=300px;" type="Text" Value=""/><input type="submit" value="Open" OnClick="SelectBackupFile()" /></td>
</tr>
<tr>
<td>Restore Folder:</td><td><input id="txtRestoreFolder" style="width=300px;" type="Text" Value="" /><input type="submit" value="Open" OnClick="SelectRestoreFolder()" /></td>
</tr>
<tr>
<td>SQL Server Instance:</td>
<td>
<select name="selInstances">
</select>
<input id="chkIntegrated" type="checkbox" checked="true" OnClick="ShowAuth()">Integrated Security</input>
</td>
<tr id="trUserName" style="display:none">
<td>UserName:</td><td><input id="txtUserName" style="width=200px;" type="Text" /></td>
</tr>
<tr id="trPassword" style="display:none">
<td>Password</td><td><input id="txtPassword" style="width=200px;" type="password" /></td>
</tr>
<tr>
<td>Database Name:</td><td><input id="txtDBName" style="width=200px;background-color:#dfe0e5" disabled="disabled" type="Text" /><input id="chkDBNameDefault" type="checkbox" checked="true" OnClick="DefaultOptionChanged">Use Default</input></td>
</tr>
</table>
<br/>
<input type="submit" value="Restore Database" OnClick="RestoreDatabase()" />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<input type="submit" value="Close" OnClick="Close()" />
<br/>
<span id="RestoreInProgress" style="display:none">Database is been restored - this might take a while depending on the size of the database. Please wait...</span>
<span id="RestoreCompleted" style="display:none">Restore Completed.</span>
<span id="RestoreError"></span>
<div id="Footer">
<hr/>
 <div style="float:left;">Version 1.0</div>
 <div style="float:right;">By David Wiseman<br />
 </div>
 <div style="clear:both;"></div>
 <div style="text-align:center;font-size:12px;font-weight:bold"><a href="http://www.wisesoft.co.uk">www.wisesoft.co.uk</a></div>
</div>

</body></html>

Drive Space Report

Sun, 03 Aug 2008 21:00:00 +0000

Display a drive space report for multiple computers. This HTA can check the drives of multiple computers and produce a HTML report that will highlight any drives that are low on free space. The HTA also generates a CSV version of the report.

The Drive Space Report is a GUI script that allows you to view the disk drives and free space on several computers. Just enter the computer name or IP Address, one per line and click the “Generate Report” button to display the report. Click the “Download Report (CSV)” button to save the report in CSV (comma separated) format.

Drive Space Report


 1
 2
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280


<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<head>
 <title>WiseSoft Drive Space Report</title>
 <hta:application applicationname="WiseSoft Drive Space Report" scroll="yes" singleinstance="yes"
 windowstate="normal">
<style type="text/css">
 body
 {
 background-color: #F2F2F2;
 font: bold 10pt arial,sans-serif;
 color:#787878;
 margin:0px;
 }
 table
 {
 width: 400;
 border: 2px solid;
 border-collapse: collapse;
 border-color: #696969;
 }
 th
 {
 border: 1px dotted #111111;
 border-color: #787878;
 color: #FFFFFF;
 font: bold 12pt arial,sans-serif;
 background-color: #787878;
 text-align: left;
 }
 td
 {
 border: 1px dotted #111111;
 border-color: #787878;
 font: bold 10pt arial,sans-serif;
 color: #787878;
 }
 .neutral
 {
 background-color: #FFFFE0;
 color: #787878;
 }
 .good
 {
 background-color: green;
 color: white;
 }
 .warning
 {
 background-color: yellow;
 color: black;
 }
 .critical
 {
 background-color: red;
 color: black;
 }
 .tableHead td
 {
 padding: 5px;
 font: bold 14pt arial,sans-serif;
 background-color: #787878;
 text-align: center;
 color: white;
 }
 h1
 {
 background-color: #787878;
 color: white;
 font: bold 20pt arial,sans-serif;
 text-align: center;
 }
</style>
</head>

<script language="VBScript">

	OPTION EXPLICIT
 
 ' ********** Constants **********
 CONST bytesToMB = 1048576
 CONST bytesToGB = 1073741824
 CONST bytesToTB = 1099511627776
	CONST warningLevel = 20 ' < 20% = warning (yellow)
	CONST criticalLevel = 10 ' < 10% = critical (red)
	CONST goodLevel = 50 ' > 50% = good (green)
	' **********************************

	SUB GetDriveReportsHTML
		DIM html, strComputer,strComputers
		
		strComputers = txtComputers.value
		
		FOR EACH strComputer in SPLIT(strComputers,CHR(13))
		 strComputer = TRIM(REPLACE(strComputer,CHR(10),""))
		 IF strComputer <> "" THEN
			 html = html & GetDriveReportHTML(strComputer)
			END IF
		NEXT
		report.InnerHTML = html
	END SUB

 FUNCTION ConvertToDiskUnit(BYVAL value) 
 IF (value/bytesToTb) > 1 THEN
 ConvertToDiskUnit = ROUND(value / bytesToTB,1) & " TB"
 ELSEIF (value/bytesToGb) > 1 THEN
 ConvertToDiskUnit = ROUND(value / bytesToGB,1) & " GB"
 ELSE
 ConvertToDiskUnit = ROUND(value / bytesToMB,1) & " MB"
 END IF
 END FUNCTION

	FUNCTION GetDriveReportHTML(BYVAL strComputer)

		DIM objWMIService, objItem, colItems
		DIM strDriveType, strDiskSize, htmlDriveReport

		ON ERROR RESUME NEXT
		SET objWMIService = GETOBJECT("winmgmts:\\" & strComputer & "\root\cimv2")
		IF Err.Number <> 0 THEN
			GetDriveReportHTML = "<span class=""critical"">Error connecting to '" & strComputer & "'</span><br/><br/>"
			Err.Clear
			ON ERROR GOTO 0
			EXIT FUNCTION
		END IF

		ON ERROR GOTO 0
		SET colItems = objWMIService.ExecQuery("Select * from Win32_LogicalDisk WHERE DriveType=3")

		htmlDriveReport = "<table><tr class=""tableHead""><td colspan=""5"">" & strComputer & _
				"</td></tr><tr><th>Drive</th><th>Size</th><th>Used</th><th>Free</th><th>Free(%)</th></tr>"

		FOR EACH objItem in colItems
	
			DIM pctFreeSpace,strFreeSpace,strusedSpace, cssClass
			pctFreeSpace = ROUND(((objItem.FreeSpace / objItem.Size) * 100),1)
			strDiskSize = ConvertToDiskUnit(objItem.Size) 
			strFreeSpace = ConvertToDiskUnit(objItem.FreeSpace)
			strUsedSpace = ConvertToDiskUnit(objItem.Size-objItem.FreeSpace)

			IF pctFreeSpace < criticalLevel THEN
				cssClass = "critical"
			ELSEIF pctFreeSpace < warningLevel THEN
				cssClass = "warning"
			ELSEIF pctFreeSpace > goodLevel THEN
				cssClass = "good"
			ELSE
				cssClass = "neutral"
			END IF

			DIM strChart 
			strChart = "<div style=""width=100%;""><span style=""width=" & 100-pctFreeSpace & _
				"%;background-color:blue;""></span><span style=""width=" & pctFreeSpace & _
				"%;background-color:#FF00FF;""></span></div>"

			htmlDriveReport = htmlDriveReport & "<tr><td>" & objItem.Name & strChart & "</td><td>" & _
					strDiskSize & "</td><td>" & strUsedSpace & "</td><td>" & _
					strFreeSpace & "</td><td class=""" & cssClass & """>" & pctFreeSpace & "%</td></tr>"

		NEXT
	
		htmlDriveReport = htmlDriveReport + "</table></br>"

		GetDriveReportHTML = htmlDriveReport
	
	END FUNCTION
	
	SUB GetDriveReportsCSV
	 DIM csv, strComputer,strComputers, path
		
		strComputers = txtComputers.value
		
		csv = "Computer,Drive,Size,Used,Free,Free(%)"
		
		FOR EACH strComputer in SPLIT(strComputers,CHR(13))
		 strComputer = TRIM(REPLACE(strComputer,CHR(10),""))
		 IF strComputer <> "" THEN
		 IF csv <> "" THEN
		 csv = csv & VbCrLf
		 END IF
			 csv = csv & GetDriveReportCSV(strComputer)
			END IF
		NEXT
	 path = INPUTBOX("Enter FileName:","Enter FileName","MyDriveReport.csv")
	 IF path = "" THEN
	 EXIT SUB
	 END IF
	 WriteTextFile csv, path
	 END SUB
	
	FUNCTION GetDriveReportCSV(BYVAL strComputer)

		DIM objWMIService, objItem, colItems
		DIM strDriveType, strDiskSize, csvDriveReport

		ON ERROR RESUME NEXT
		SET objWMIService = GETOBJECT("winmgmts:\\" & strComputer & "\root\cimv2")
		IF Err.Number <> 0 THEN
			GetDriveReportCSV = strComputer & ",Error,Error,Error,Error,Error"
			Err.Clear
			ON ERROR GOTO 0
			EXIT FUNCTION
		END IF

		ON ERROR GOTO 0
		SET colItems = objWMIService.ExecQuery("Select * from Win32_LogicalDisk WHERE DriveType=3")

		FOR EACH objItem in colItems
	
			DIM pctFreeSpace,strFreeSpace,strusedSpace, cssClass
			pctFreeSpace = ROUND(((objItem.FreeSpace / objItem.Size) * 100),1)
			strDiskSize = ConvertToDiskUnit(objItem.Size) 
			strFreeSpace = ConvertToDiskUnit(objItem.FreeSpace)
			strUsedSpace = ConvertToDiskUnit(objItem.Size-objItem.FreeSpace)

			IF pctFreeSpace < criticalLevel THEN
				cssClass = "critical"
			ELSEIF pctFreeSpace < warningLevel THEN
				cssClass = "warning"
			ELSEIF pctFreeSpace > goodLevel THEN
				cssClass = "good"
			ELSE
				cssClass = "neutral"
			END IF
			
			IF csvDriveReport <> "" THEN 
			 csvDriveReport = csvDriveReport & VbCrLf
			END IF

			csvDriveReport = csvDriveReport & strComputer & "," & objItem.Name & "," & _
					strDiskSize & "," & strUsedSpace & "," & _
					strFreeSpace & "," & pctFreeSpace & "%"

		NEXT
		
		GetDriveReportCSV = csvDriveReport

	END FUNCTION
	
	SUB WriteTextFile(BYVAL txt,BYVAL path)
	 DIM objFSO, objTextFile
	 
 SET objFSO = CREATEOBJECT("Scripting.FileSystemObject")
 
 IF objFSO.FileExists(path) THEN
 IF MSGBOX("Warning: file already exists! Overwrite file?",vbYesNo+vbQuestion,"Overwrite File?") = vbNo THEN
 EXIT SUB
 END IF
 END IF

 SET objTextFile = objFSO.CreateTextFile(path)

 objTextFile.Write(txt)
 objTextFile.Close
 MSGBOX "Created '" & path & "' Report",vbOKOnly+vbInformation
	END SUB

</script>

<body>
 <h1 style="margin-bottom: 0px;">
 Drive Space Report</h1>
 <div style="text-align: right; font: bold 8pt arial,sans-serif; color: #787878;">
 By David Wiseman, <a target="_blank" href="http://www.wisesoft.co.uk">www.wisesoft.co.uk</a>
 </div><br />
 <div style="text-align: center;">
Enter names of computers (one line per computer):<br />
 <textarea name="txtComputers" rows="4" cols="50">
localhost
.
127.0.0.1
 </textarea><br />
 <input style="font-weight:bold;" onclick="GetDriveReportsHTML" type="submit" value="Generate Report"></input> 
 <input onclick="GetDriveReportsCSV" type="submit" value="Download Report (CSV)"></input>
 <br />
 <br />
 </div>
 <div style="text-align: center;" id="report">
 </div>
</body>
</html> 