DSC: Script Resource GetScript
If you look on the TechNet page for the Script Resource you will see
GetScript = { <# This must return a hash table #> }Which is technically speaking, true...usually...right up until the point you try to run Get-DscConfiguration on a machine, in which case it will get to that script resource and die saying:
The PowerShell provider returned results that are not valid from Get-TargetResource. The <keyname> key is not a valid property in the corresponding provider schema file. The results from Get-TargetResource must be in a Hashtable format. The keys in the Hashtable must be the same as the properties in the corresponding provider schema file.
The consensus around the web is that the error is saying you have to return a hashtable with keys that match the properties of the schema, so in this case the schema for the Script resource is:
#pragma namespace("\\\\.\\root\\microsoft\\windows\\DesiredStateConfiguration")
[ClassVersion("1.0.0"),FriendlyName("Script")]
class MSFT_ScriptResource : OMI_BaseResource
{
[Key] string GetScript;
[Key] string SetScript;
[Key] string TestScript;
[write,EmbeddedInstance("MSFT_Credential")] string Credential;
[Read] string Result;
};Which means in order for your Script resource to be compliant you need to return:
GetScript = {return @{ Result = ();GetScript=$GetScript;TestScript=$TestScript;SetScript=$SetScript}} But when you think about it, this doesn't make a lot of sense. In every other resource I can think of it makes absolute sense, because the parameters in the schema determine the status of the resource you want to control, not how you control it and how you test for it.
It would be like Get-TargetResource for the Registry resource not returning the information about the key, its value, etc. but rather returning that AND returning the entire contents of MSFT_RegistryResource.psm1 which would make literally no sense. We don't care HOW you check or HOW you set, and returning a Get-Script with the contents of Get-Script is...batty...we care about the resource being controlled.
Luckily, the statement that "the keys need to match the parameters" can be interpreted to mean you need to match ALL of them, or it can be interpreted to mean "they just need to exist" and in the case of the Script resource Result does exist. And that is what we need to return.
GetScript = {return @{Result=''}} They really need to update the TechNet page to say "GetScript needs to return a hash table with at least one key matching a parameter in the schema for the resource".
No need to return potentially hundreds of lines of code in some M.C. Escher-like construct containing itself. Just stick to returning information about the resource you are controlling. If your script sets the contents of a file, return the contents of that file. Not the contents of the file AND the script you used to set it AND the script you used to test it.
Bundle DSC Waves for Pull Server Distribution
This assumes you have WinRar installed to the default path, this will also delete the source files after it creates the zip files.
After running this script copy the resulting files to the DSC server in the following location: "C:\Program Files\WindowsPowerShell\DscService\Modules"
$modpath = "-path to dsc wave-"
$output = "-path to save wave to-"
[regex]$reg = "([0-9\.]{3,12})"
if((Test-Path $output) -ne $true){ New-Item -Path $output -ItemType Directory -Force }
foreach($module in (Get-ChildItem -Path $modpath)) {
$psd1 = ($module.FullName+"\"+$module+".psd1")
$content = Get-Content $psd1
foreach($line in $content) {
if($line.Contains("ModuleVersion")) {
$outpath = $output+"\"+$module.Name+"_"+($reg.Match($line).Captures)
Write-Host ""
if(Test-Path -Path $outpath) {
Copy-Item -Path $module.FullName -Destination $outpath -Recurse
}else{
New-Item -Path $outpath -ItemType Directory -Force
Copy-Item -Path $module.FullName -Destination $outpath -Recurse
}
& "C:\Program Files\WinRar\winrar.exe" a -afzip -df -ep1 ($outpath+".zip") $outpath
}
}
}
Start-Sleep -Seconds 1
New-DscCheckSum -Path $outputPowerShell: DSC, Custom Modules, Custom Resources, and Timing...
Hypothetical situation, you want to accomplish the following:
- Install the App-V 5.0 SP2 client.
- Configure the client.
- Restart the service.
- Import App-V sequences.
If that sounds simple to you, then you haven't tried it in DSC.
If fairness it isn't THAT complex, but it isn't very straight forward either, and there is little real reason for it to be complicated beyond a simple lack of foresight on the part of the DSC engine.
The first three tasks are very simple, a Package resource, a Registry resource, and a Script resource. But that last bit is tricky, and that is because it needs the modules installed in step 1 in order to work, but given that the DSC engine loads the ENTIRE script (which is normal for powershell, but given the nature of what the DSC engine does this is, IMO, a BIG hinderance) they aren't there when it first processes, so it pukes. You can tell this is your problem if you see a "Failed to delete current configuration." error (the config btw should at that point be visible right where WebDownloadManager left is, C:\Windows\Temp\<seriesofdigits>) as well as a complaint that the module at whatever location could not be imported because it does not exist.
So what is the solution?
Sadly kind of convoluted. First lets look at the config. Pretty simple, I call a custom resource that imports the App-V sequences and in that custom resource I have a snippet of code at the very top:
$modPath = "C:\Program Files\Microsoft Application Virtualization\Client\AppvClient"
if((Test-Path -Path $modPath) -eq $true){ Import-Module $modPath }else{ $bypass = $true }Now lets look at the script baked into the PVS image:
- Enable WinRM. Easier to do this than undo it in the VERY unlikely case we dont want it, DSC needs it so...
- Create a scripts directory. Not terribly important, you could just bake your script into this path.
- Find this hosts role/guid from an XML file stored on the network.
- Create LCM config.
- Apply LCM config.
- Copy modules from DSC Module share. This overlaps with the DSC config but the DSC config will run intermittently, not just once, for consistency.
- Shell out a start to the Consistency Engine.
This last bit is VERY important in two regards. The first is that if you just run powershell.exe with that command it WILL exit your script. The only way I've found to prevent this is to shell out so that it closes the shell, not your script. StartInfo.UseShellExecute is thus very important.
The second important bit is wiping out the WMI provider, without this it waited three minutes and ran again and promptly behaved like the $bypass was still being tripped, even though I could verify the module WAS in fact in place, I do not like this caching at all.
So the first time I run consistency I know it wont put everything in place, because it needs the client installed before the client modules exist and even with DependsOn=[Package]Install it still pukes, depends on doesn't seem to have any impact on how it loads in the resources.
I wait three minutes because I want to give the client time to install, I don't love this but this is just example code, in reality you would mainly be concerned with two things:
- Is the LCM still running.
- Is the client installed.
So I would probably watch event viewer and the client module folder before making my second run, timing out after ten minutes or so (in this case 15 minutes later the scheduled task will run it again anyway, don't want to get in the way).
Why bother with this? Mainly because I don't want to wait half an hour for my server to be functional. I run them initially back to back because I can either bake the GUID in, or use a script to "provision" that, while I'm there why rely on the scheduled task? This is on a Server 2008 R2 server so I can't use the Get-ScheduledTask cmdlet, and while yes I could bake in the Consistency task with a shorter trigger and change it in my DSC config...but that is just as much work and more moving parts.
I want to configure and make my initial pass as quickly as is safe to do so, and then allow it to poll for consistency thereafter.
Citrix: Creating Reports.
A bit of a different gear here, but here are a couple examples, one using Citrix 4.5 (Resource Manager) andone using Citrix 6.0 (EdgeSight).
$start = Get-Date
Import-Module ActiveDirectory
function SQL-Connect($server, $port, $db, $userName, $passWord, $query) {
$conn = New-Object System.Data.SqlClient.SqlConnection
$ctimeout = 30
$qtimeout = 120
$constring = "Server={0},{5};Database={1};Integrated Security=False;User ID={2};Password={3};Connect Timeout={4}" -f $server,$db,$userName,$passWord,$ctimeout,$port
$conn.ConnectionString = $constring
$conn.Open()
$cmd = New-Object System.Data.SqlClient.SqlCommand($query, $conn)
$cmd.CommandTimeout = $qtimeout
$ds = New-Object System.Data.DataSet
$da = New-Object System.Data.SqlClient.SqlDataAdapter($cmd)
$da.fill($ds)
$conn.Close()
return $ds
}
function Graph-Iterate($arList,$varRow,$varCol,$strPass) {
Write-Host $arList[$i].depName
foreach($i in $arList.Keys) {
if($arList[$i].duration -ne 0) {
if($arList[$i].depName.Length -gt 1) {
$varRow--
if($arList[$i].depName -eq $null){ $arList[$i].depName = "UNKNOWN" }
$sheet.Cells.Item($varRow,$varCol) = $arList[$i].depName
$varRow++
$sheet.Cells.Item($varRow,$varCol) = ("{0:N1}" -f $arList[$i].duration)
$varCol++
if($master -ne $true){ Iterate $arList[$i] $strPass }
}
}
}
return $varcol
}
function Iterate($arSub, $strCom) {
$indSheet = $workbook.Worksheets.Add()
$sheetName = ("{0}-{1}" -f $strCom,$arSub.depName)
Write-Host $sheetName
$nVar = 1
if($sheetName -eq "CSI-OPP MAX")
{
Write-Host "The Var is:"
Write-Host $nVar
$sheetName = "{0} {1}" -f $sheetName,$nVar
$nVar++
}
$strip = [System.Text.RegularExpressions.Regex]::Replace($sheetName,"[^1-9a-zA-Z_-]"," ");
if($strip.Length -gt 31) { $ln = 31 }else{ $ln = $strip.Length }
$indSheet.Name = $strip.Substring(0, $ln)
$count = $arSub.Keys.Count
$array = New-Object 'object[,]' $count,2
$arRow = 0
foreach($y in $arSub.Keys) {
if($y -ne "depName" -and $y -ne "duration" -and $y.Length -gt 1) {
$t = 0
$array[$arRow,$t] = $y
$t++
$array[$arRow,$t] = $arSub[$y]
$arRow++
}
}
$rng = $indSheet.Range("A1",("B"+$count))
$rng.Value2 = $array
}
function Create-Graph($lSheet,$lTop,$lLeft,$range, $number, $master, $catRange) {
# Add graph to Dashboard and configure.
$chart = $lSheet.Shapes.AddChart().Chart
$chartNum = ("Chart {0}" -f $cvar3)
$sheet.Shapes.Item($chartNum).Placement = 3
$sheet.Shapes.Item($chartNum).Top = $top
$sheet.Shapes.Item($chartNum).Left = $left
if($master -eq $true) {
$sheet.Shapes.Item($chartNum).Height = 500
$sheet.Shapes.Item($chartNum).Width = 1220
}else{
$sheet.Shapes.Item($chartNum).Height = 325
$sheet.Shapes.Item($chartNum).Width = 400
}
$chart.ChartType = 69
$chart.SetSourceData($range)
$chart.SeriesCollection(1).XValues = $catRange
}
$port = "<port>"
$server = "<sqlserver>"
$db = "<db>"
$user = "<db_user>"
$password = "<pass>"
$query = "SELECT p.prid, p.account_name, p.domain_name, p.dtfirst, cs.instid, cs.sessid, cs.login_elapsed, cs.dtlast, cs.session_type, s.logon_time, s.logoff_time
FROM dbo.principal AS p INNER JOIN
dbo.session AS s ON s.prid = p.prid INNER JOIN
dbo.ctrx_session AS cs ON cs.sessid = s.sessid"
#WHERE p.account_name LIKE 'a[_]%'
$userlist = SQL-Connect $server $port $db $user $password $query
$users = @{}
foreach($i in $userlist.Tables) {
if($i.account_name -notlike "h_*" -and $i.account_name -notlike "a_*" -and $i.account_name -ne "UNKNOWN" -and ([string]$i.logon_time).Length -gt 1 -and ([string]$i.logoff_time).Length -gt 1) {
try {
$info = Get-ADUser -Identity $i.account_name -Properties DepartmentNumber, Department, Company
}
catch {
$info = @{"Company"="Terminated";"Department"="Invalid";"DepartmentNumber"="0000"}
}
if($info.Company.Length -lt 2) {
$info = @{"Company"="Terminated";"Department"="Invalid";"DepartmentNumber"="0000"}
}
if($users.Contains($info.Company) -eq $false) {
$users[$info.Company] = @{}
$users[$info.Company]['duration'] = (New-TimeSpan $i.logon_time $i.logoff_time).TotalHours
}else{
$users[$info.Company]['duration'] = $users[$info.Company]['duration']+(New-TimeSpan $i.logon_time $i.logoff_time).TotalHours
}
if($users[$info.Company].Contains(([string]$info.DepartmentNumber)) -eq $false) {
$users[$info.Company][([string]$info.DepartmentNumber)] = @{}
$users[$info.Company][([string]$info.DepartmentNumber)]['depName'] = $info.Department
$users[$info.Company][([string]$info.DepartmentNumber)]['duration'] = (New-TimeSpan $i.logon_time $i.logoff_time).TotalHours
}else{
$users[$info.Company][([string]$info.DepartmentNumber)]['duration'] = $users[$info.Company][([string]$info.DepartmentNumber)]['duration']+(New-TimeSpan $i.logon_time $i.logoff_time).TotalHours
}
if($users[$info.Company][([string]$info.DepartmentNumber)].Contains($i.account_name) -eq $false) {
$users[$info.Company][([string]$info.DepartmentNumber)][$i.account_name] = (New-TimeSpan $i.logon_time $i.logoff_time).TotalHours
}else{
$users[$info.Company][([string]$info.DepartmentNumber)][$i.account_name] = $users[$info.Company][([string]$info.DepartmentNumber)][$i.account_name]+(New-TimeSpan $i.logon_time $i.logoff_time).TotalHours
}
}elseif($i.account_name -ne "UNKNOWN" -and ([string]$i.logon_time).Length -gt 1 -and ([string]$i.logoff_time).Length -gt 1) {
if($i.account_name -like "a_*") {
$info = @{"Company"="Administrators";"Department"="Elevated IDs (A)";"DepartmentNumber"="1111"}
}else{
$info = @{"Company"="Administrators";"Department"="Elevated IDs (H)";"DepartmentNumber"="2222"}
}
if($users.Contains("Administrators") -eq $false) {
$users['Administrators'] = @{}
$users['Administrators']['duration'] = (New-TimeSpan $i.logon_time $i.logoff_time).TotalHours
}else{
$users['Administrators']['duration'] = $users['Administrators']['duration']+(New-TimeSpan $i.logon_time $i.logoff_time).TotalHours
}
if($users['Administrators'].Contains($info.DepartmentNumber) -eq $false) {
$users['Administrators'][$info.DepartmentNumber] = @{}
$users['Administrators'][$info.DepartmentNumber]['depName'] = $info.Department
$users['Administrators'][$info.DepartmentNumber]['duration'] = (New-TimeSpan $i.logon_time $i.logoff_time).TotalHours
}else{
$users['Administrators'][$info.DepartmentNumber]['duration'] = $users['Administrators'][$info.DepartmentNumber]['duration']+(New-TimeSpan $i.logon_time $i.logoff_time).TotalHours
}
if($users['Administrators'][$info.DepartmentNumber].Contains($i.account_name) -eq $false) {
$users['Administrators'][$info.DepartmentNumber][$i.account_name] = (New-TimeSpan $i.logon_time $i.logoff_time).TotalHours
}else{
$users['Administrators'][$info.DepartmentNumber][$i.account_name] = $users['Administrators'][$info.DepartmentNumber][$i.account_name]+(New-TimeSpan $i.logon_time $i.logoff_time).TotalHours
}
}else{
if(([string]$i.logon_time).Length -lt 1 -and $i.account_name -ne "UNKNOWN"){ "No logon time: "+$i.account_name }
if(([string]$i.logoff_time).Length -lt 1 -and $i.account_name -ne "UNKNOWN"){ "No logoff time: "+$i.account_name }
}
}
# Create Excel object, setup spreadsheet, name main page.
$excel = New-Object -ComObject excel.application
$excel.Visible = $true
$excel.DisplayAlerts = $false
$workbook = $excel.Workbooks.Add()
$row = 1
$col = 1
$sheet = $workbook.Worksheets.Item(1)
$sheet.Name = "Dashboard"
# Populate tracking vars.
# $row is the starting row to begin entering data into text cells.
# $cvar tracks $left position, resets when it reaches 3.
# $cvar3 tracks $top position, after every third graph it increments +340.
$row = 202
$col = 2
$cvar = 1
$cvar3 = 1
$top = 10
$left = 10
# Iterate through main element (Companies), $z returns company name (MGTS, MR, etc.).
$min = ($sheet.Cells.Item(($row)-1,1).Address()).Replace("$", "")
$tmin = ($sheet.Cells.Item(($row)-1,2).Address()).Replace("$", "")
foreach($q in $users.Keys) {
$sheet.Cells.Item($row,1) = "Maritz Total Citrix Usage (by hours)"
$row--
if($q -eq "114"){ $q = "Training IDs" }
$sheet.Cells.Item($row,$col) = $q
$row++
$sheet.Cells.Item($row,$col) = ("{0:N1}" -f $users[$q].duration)
$col++
}
$max = ($sheet.Cells.Item($row,($col)-1).Address()).Replace("$", "")
$range = $sheet.Range($min,$max)
$range2 = $sheet.Range($tmin,$max)
Create-Graph $sheet $top $left $range $cvar3 $true $range2
$row++;$row++
$col = 2
$top = ($top)+510
$cvar3++
foreach($z in $users.Keys) {
if($z.Length -gt 1 -and $z -ne "112 MAS"){
# Setup chart location vars.
if($cvar -eq 1) {
$left = 10
}elseif($cvar -eq 2){
$left = 420
}elseif($cvar -eq 3) {
$left = 830
}
$col = 2
$sheet.Cells.Item($row,1) = $z
# Track chart range minimum cell address.
$min = ($sheet.Cells.Item(($row)-1,1).Address()).Replace("$", "")
$tmin = ($sheet.Cells.Item(($row)-1,2).Address()).Replace("$", "")
# Iterate through secondary element (Departments), $i returns department name.
# Graph-Iterate Here
$vLoc = Graph-Iterate $users[$z] $row $col $z
# Track chart range maximum cell address.
$max = ($sheet.Cells.Item($row,($vLoc)-1).Address()).Replace("$", "")
$range = $sheet.Range($min,$max)
$range2 = $sheet.Range($tmin,$max)
Create-Graph $sheet $top $left $range $cvar3 $false $range2
$row++;$row++
# Increment or reset tracking vars.
if($cvar -eq 3) {
$top = ($top)+340
}
if($cvar -eq 1 -or $cvar -eq 2){ $cvar++ }elseif($cvar -eq 3){ $cvar = 1}
$cvar3++
}
}
# Show dashboard page rather than some random department.
$sheet.Activate()
New-TimeSpan -Start $start -End (Get-Date)