MasterPromptPS is a Light Touch build menu generator for Microsoft Endpoint Configuration Manager. Values selected in the form are stored as task sequence variables.
Sign in to like and favorite skills
MasterPromptPS is a Light Touch build menu generator for Microsoft Endpoint Configuration Manager. Values selected in the form are stored as task sequence variables.
[[TOC]]
MasterPromptPS.ps1 [[-SettingsFile] <String>] [-HideProgress] [-SCCM] [-Test] [<CommonParameters>]Specifies the json file with the settings and menu definition.
"$PSScriptRoot\MasterPromptPS.json"Hide the SCCM/MDT task sequence progress bar.
Generate SCCM/MDT Task Sequence variables.
Run in test mode.
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters https:/go.microsoft.com/fwlink/?LinkID=113216.
PS C:\>.\MasterPromptPS -SetVariablesDisplay a prompt as defined by the MasterPromptPS.json file (default) located in the current directory and store results in answers.json and as task sequence variables.
PS C:\>.\MasterPromptPS -HideProgress -SetVariablesHide the MDT or SCCM progress bar, display a prompt as defined by the MasterPromptPS.json file (default) located in the current directory and store results in answers.json and as task sequence variables.
PS C:\>.\MasterPromptPS -SettingsFile .\server.jsonDisplay a prompt as defined by .\server.json and store results in answers.json.
Settings and menu definition are stored in a .json file. If a file named MasterPromptPS.json is found in the current directory, MasterPromptPS will use that.
MasterPromptPS supports the following field types:
The settings file contains a number of global properties and settings:
All field types require the following three parameters
NOTE: Radio Buttons are packed right to left. Radio button options must be specified in reverse order in the JSON file.
options: a json object array of value/label pairs to define dropdown menu options
OR
default: a wmi query that selects at least fields
wmiLabel: the wmi property to assign to the dropdown menu label
wmiValue: the wmi property to assign to the dropdown menu value
{ "__version__": "0.1.4", "__description__": "Sample settings file", "width": 500, "height": 585, "rowHeight": 25, "labelColumnX": 10, "fieldColumnX": 150, "rowY": 90, "textBoxSize": 320, "title": "Build Prompt", "header": "", "footer": "Warning: This system is about to be rebuilt resulting in the loss of all data. If you DO NOT wish to proceed, immediately power off and remove any thumb drives.", "errorColor": "#FFFF77", "headerColor": "#47154A", "fields": [{ "type": "info", "name": "infIpAddress", "label": "IP Address", "query": "SELECT IPAddress FROM Win32_NetworkAdapterConfiguration WHERE IPEnabled = True AND DHCPEnabled = True" }, { "type": "info", "name": "InfMacAddress", "label": "MAC Address", "query": "SELECT MACAddress FROM Win32_NetworkAdapterConfiguration WHERE IPEnabled = True AND DHCPEnabled = True" }, { "type": "text", "name": "OSDComputerName", "label": "Computer Name", "default": "SELECT SerialNumber FROM Win32_BIOS", "required": true, "maxLength": 15 }, { "type": "select", "name": "BUILD", "label": "Build", "options": { "standard": "Standard", "marketing": "Marketing", "it": "IT" } }, { "type": "select", "name": "nic", "label": "NIC", "default": "select Name,Index from Win32_NetworkAdapter where NetConnectionStatus = 2 AND AdapterTypeID = 0", "wmiLabel": "Name", "wmiValue": "Index" }, { "type": "password", "name": "PASSWORD", "label": "Password", "required": true }, { "type": "check", "name": "OPTION1", "label": "Option 1?", "checked": true }, { "type": "radio", "name": "radioEx", "label": "Radio Example", "default": "standard", "options": { "standard": "Standard", "marketing": "Marketing", "it": "IT" } }, { "type": "radio", "name": "radioEx2", "label": "Radio Example 2", "default": "rexO2", "options": { "rexO1": "Rex Opt 1", "rexO2": "Rex Opt 2", "rexO3": "Rex Opt 3" } }, { "type": "cascade", "name": "cascadeEx", "label": "Cascade Example", "dependsOn": "BUILD", "options": { "standard": { "std1": "Std 1", "std2": "Std 2", "std3": "Std 3" }, "marketing": { "m1": "M 1", "m2": "M 2", "m3": "M 3" }, "it": { "it1": "IT 1", "it2": "IT 2", "it3": "IT 3" } } } ] }
Text, password and select fields are validated for non empty, non null values by default.
This script will save all answers in the answers.json file in the current directory.
{ "dnsSuffix": "test.local", "adapter_label": "Intel(R) Wi-Fi 6E AX211 160MHz", "gateway": "1.1.1.1", "subnetMask": "255.255.255.0", "dnsServers": "1.1.1.3", "ipAddress": "1.1.1.2", "adapter": 1 }
To add custom validation, add a PowerShell script to the customvalidators folder named the same as the Text or Password fields you wish to validate. The script must return a boolean value indicating if the field is valid and display any corrective messages if required.
Custom validation scripts can also be used as a warning only (i.e. will not halt processing) if all exit paths are set to $True.
This script will confirm if the OSDComputerName field begins with any of a set of allowed prefixes. If not it displays a popup message and returns boolean $False.
Param( [string]$Value ) $Allowed = @( "US", "UK", "ES" ) $Buttons = [System.Windows.Forms.MessageBoxButtons]::OK $Icon = [System.Windows.Forms.MessageBoxIcon]::Error# <-- Change to' Warning' to use as a 'warning' only prompt $Message = "The computer name must begin with one of the following: $($Allowed -join ', ')" $Title = "Error" If(($Value[0..1] -join '').ToLower() -notin $Allowed){ [System.Windows.Forms.MessageBox]::Show($Message,$Title,$Buttons,$Icon) | Out-Null $false # <-- Change to $true to use as a 'warning' only prompt }else{ $true }
After the form is validated and submitted, this script will execute every .ps1 file in the customactions subdirectory.
# NOTE: This script must be written to operate within WinPE which does not include thr NetTCPIP module. # Get Answers $answers = Get-Content -Path "$PSScriptRoot\..\answers.json" | ConvertFrom-Json Write-Output "Configuring $($answers.adapter_label)..." # Get the network adapter by index $adapter = Get-CimInstance -ClassName Win32_NetworkAdapterConfiguration -Filter "Index = $($answers.adapter)" # Set the IP address, subnet mask, and default gateway $adapter | Invoke-CimMethod -MethodName EnableStatic -Arguments @{IPAddress=@($($answers.ipAddress)); SubnetMask=@($($answers.subnetMask))} $adapter | Invoke-CimMethod -MethodName SetGateways -Arguments @{DefaultIPGateway=@($($answers.gateway))} # Set the DNS servers $adapter | Invoke-CimMethod -MethodName SetDNSServerSearchOrder -Arguments @{DNSServerSearchOrder=$($($answers.dnsServers) -split ",")} # Set the domain $adapter | Invoke-CimMethod -MethodName SetDNSDomain -Arguments @{DNSDomain=$($answers.dnsSuffix)}
PS C:\> MasterPromptPS.ps1 -SettingsFile sample_menu.json -TestDisplay a dialog box as defined in sample_menu.json, do not run custom actions and enable pressing ESC to quit. Validate the entries as defined in the JSON file and according to the boolean result of powershell scripts in the customactions directory. Save the results in "answers.json".
PS C:\> MasterPromptPS.ps1 -SettingsFile sample_menu.json -HideProgress -SetVariablesDisplay a dialog box as defined in sample_menu.json and run custom actions. Validate the entries as defined in the JSON file and according to the boolean result of powershell scripts in the customactions directory. Save the results in "answers.json", temporarily hide the SCCM/MDT progress dialog and save all values as Task Sequence variables.