Windows.Computer.DataOnDemand.Addendum.GetComputerDescription.WriteAction

Windows.Computer.DataOnDemand.Addendum.GetComputerDescription.WriteAction (WriteActionModuleType)

Displays the computers' description locally and from Active Directory
Note: JSON format is only supported if PowerShell v3 or later is installed on the target server.

Element properties:

Member Modules:

Overrideable Parameters:

Source Code:

<WriteActionModuleType ID="Windows.Computer.DataOnDemand.Addendum.GetComputerDescription.WriteAction" Accessibility="Public" Batching="false">

  <Configuration>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="Format" type="xsd:string"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="TimeoutSeconds" type="xsd:integer"/>

  </Configuration>

  <OverrideableParameters>

    <OverrideableParameter ID="Format" Selector="$Config/Format$" ParameterType="string"/>

    <OverrideableParameter ID="TimeoutSeconds" Selector="$Config/TimeoutSeconds$" ParameterType="int"/>

  </OverrideableParameters>

  <ModuleImplementation Isolation="Any">

    <Composite>

      <MemberModules>

        <WriteAction ID="PowerShellWriteAction" TypeID="Windows!Microsoft.Windows.PowerShellWriteAction">

          <ScriptName>Get-ComputerDescription.ps1</ScriptName>

          <ScriptBody><Script><![CDATA[<#

.SYNOPSIS

    Get Compupter Description

.DESCRIPTION

    This script gets the local description and the one from Active Directory

.Notes

	AUTHOR: Ruben Zimmermann @ruben8z

	LASTEDIT: 2019-12-25

	REQUIRES: PowerShell Version 2, Windows Management Foundation 4, At least Windows 7 or Windows Server 2008 R2.	

REMARK:

This PS script comes with ABSOLUTELY NO WARRANTY; for details see gnu-gpl. This is free software, and you are welcome to redistribute it under certain conditions; see gnu-gpl for details.

    

#>

Param(

    [ValidateSet("text","csv","json", "list")]

    [string] $Format = "csv"

)





$ErrorActionPreference = "stop"



try {

	$computerDescription = Get-ItemProperty -Path HKLM:\SYSTEM\CurrentControlSet\services\LanmanServer\Parameters | Select-Object -ExpandProperty srvcomment -ErrorAction Stop

} catch {

	$foo = 'swallowException'

}



if (([string]::IsNullOrEmpty($computerDescription))) {

	$computerDescription = 'Not-Maintained'

} else {

	$computerDescription = $computerDescription.Trim()

	$noActionRequired  = 'Keep description'

}





$objADSearcher = New-Object System.DirectoryServices.DirectorySearcher

$objADSearcher.Filter = "(&(objectCategory=computer)(cn=$env:computername))"

$myComputerInAD = $objADSearcher.FindOne()

$myComputerInADAllProps = $myComputerInAD | Select-Object -ExpandProperty Properties



try {

  [string]$myComputerInADDescritpion = $myComputerInADAllProps.Item('description')

  [string]$myComputerInWhenCreated = $myComputerInADAllProps.Item('whenCreated')

} catch {

  $foo = 'swallowException'

}





if (([string]::IsNullOrEmpty($myComputerInADDescritpion))) {

	$myComputerInADDescritpion = 'Not-Maintained'

} else {

	$noActionRequired  = 'Keep description'

	$myComputerInADDescritpion = $myComputerInADDescritpion.Trim()

}



 

if (([string]::IsNullOrEmpty($myComputerInWhenCreated))) {

	$myComputerInWhenCreated = 'Not-Queryable'

} else {

	$noActionRequired  = 'Keep Information'

	$myComputerInWhenCreated = $myComputerInWhenCreated.Trim()

}



$myComputerDescHash = @{'Local Computer Description' = $computerDescription}

$myComputerDescHash.Add('AD Computer Description', $myComputerInADDescritpion)

$myComputerDescHash.Add('AD Computer CreationDate', $myComputerInWhenCreated)

$myComputerDescObj = New-Object -TypeName PSObject -Property $myComputerDescHash



if ($Format -eq 'text') {

	$myComputerDescObj | Format-Table -AutoSize | Out-String -Width 4096 | Write-Host

} elseif ($Format -eq 'csv') {

    $myComputerDescObj | ConvertTo-Csv -NoTypeInformation | Out-String -Width 4096 | Write-Host

} elseif ($Format -eq 'json') {

    $myComputerDescObj | ConvertTo-Json | Out-String -Width 4096 | Write-Host

} elseif ($format -eq 'list') {

    $myComputerDescObj | Format-List | Out-String -Width 4096 | Write-Host

}



# Done. (do not remove blank line following this comment as it can cause problems when script is sent to SCOM agent!)

]]></Script></ScriptBody>

          <Parameters>

            <Parameter>

              <Name>Format</Name>

              <Value>$Config/Format$</Value>

            </Parameter>

          </Parameters>

          <TimeoutSeconds>$Config/TimeoutSeconds$</TimeoutSeconds>

        </WriteAction>

      </MemberModules>

      <Composition>

        <Node ID="PowerShellWriteAction"/>

      </Composition>

    </Composite>

  </ModuleImplementation>

  <OutputType>System!System.BaseData</OutputType>

  <InputType>System!System.BaseData</InputType>

</WriteActionModuleType>