Get Objects from Powershell File

Version: 1.0

Category: Input

Extended Category: Powershell

Action Package: Standard Actions

Description

Run a powershell .ps1 file and create session objects for the result. The powershell script must receive a parameter called $outputfile and write the output to that file in UTF8 encoding. The output to the file must be one or multiple PSObjects in list format. It is possible to send additional powershell parameters to the script.

Use Cases

Example 1: Run script with no parameters

This action will run a script that do not take any parameters. It will therefor only need to run once, and the new session objects will be added to the list of session objects.

The powershell file path has been entered in global parameter POWERSHELL_PATH.

The script GetAllUsernames.ps1:

[CmdletBinding()]
Param(
 [Parameter(Mandatory=$True)]
 [string]$outputfile
)

$obj = Get-ADUser -Filter * -SearchBase 'OU=IM,DC=company,DC=local'

Out-File -FilePath $outputfile -Encoding UTF8 -InputObject ($obj | Format-List SamAccountName)

Example 2: Run script with parameters

This action will run a script that requires a parameter. It uses the value from a session attribute in the parameter value, so it has to run once for each session object.

The result will be that the current session objects will be replaced by the new objects from Powershell, containing the attributes givenname and sn.

The script GetUsersByLocation.ps1:

[CmdletBinding()]
  Param(
    [Parameter(Mandatory=$True)]
    [string]$location,
    [Parameter(Mandatory=$True)]
    [string]$outputfile
)

$result=Get-ADUser -LDAPFilter '(l=$location)'

$obj = New-Object PSObject -Property @{
  givenname = $result.GivenName
  sn = $result.Surname
 }

Out-File -FilePath $outputfile -Encoding UTF8 -InputObject ($obj | Format-List)