Log_RegisterLogfile

VB Scripting Library > OSD Scripting Library > Log functions (OSD)

Log_RegisterLogfile(sLogfile)

Registers any additional files that the upload process should parse for unwanted text and upload.

Arguments

ARGUMENT	DESCRIPTION	TYPE
sLogfile	The full path to the file	String

Return Type

Boolean, TRUE if function completed successfully.

Remarks

Typically used in the PreBootScript.wsf

• The registration is saved in the WinPE registry, so files registered in one OSD script are also submitted by later scripts in the same deployment.
• Files are registered by file name. If you register two files with the same file name in different folders, only the last one is submitted.
• Files that don’t exist when Log_SubmitLogs runs are skipped.

Example

The following example will do the following:

• Set the global variable gsLogServerFolder to a log share on the OSD server.
• Add a custom logfile is registered for submit along with the well-known logfiles.
• Register the product key as an unwanted text string that should be excluded from all files.
• Submit the logfiles.

• VBScript

Private Function IncludeScript(sScriptFile)
 '...
End Function

'Begin
  bStatus=True
  If bStatus Then bStatus=IncludeScript("customlib.cis")
  If bStatus Then bStatus=IncludeLibrary("Capalib.cin")
  If bStatus Then bStatus=IncludeLibrary("Osdlib.cin")
  If bStatus Then bStatus=Job_Start("WS","Script Name","1.0","ScriptName.log","INSTALL")
  If bStatus Then bStatus=OSD_Initialize()

  gsLogServerFolder="\\" & gsBootServer & "\LogFiles"                          'set the log folder root
  sProductKey = "11111-22222-33333-44444-55555"
  If bStatus Then bStatus=Sysprep_SetProductKey(sProductKey)

  If bStatus Then bStatus=Log_RegisterExcludeValue("Product key",sProductKey)  'remove productkey value from logfiles
  If bStatus Then bStatus=Log_RegisterWellKnownFiles()
  If bStatus Then bStatus=Log_RegisterLogfile("X:\MyTestLog.log")               'register an aditional file to submit

  If bStatus Then bStatus=Log_SubmitLogs()                                     'submit the logs

  Job_End(bStatus)
'End main

See Also

Scripting Guidelines, Log_RegisterExcludeValue, Log_RegisterWellKnownFiles, Log_RemoveLogs, Log_SubmitLogs Constants Package Property Variables