PowerShell Command

In this article

Overview

You can use the Akamai Read Snap to fetch data based on the given entity type name and last run date(if provided).

Snap Type

PowerShell Command is write snap to execute a windows command.

Prerequisites

  • None.

Limitations and Known Issues

None.

Snap Views

Input

This Snap has at most one document input view. Each document contains data in the form of json..

Output

This Snap has at most one document output view. Each document contains corresponding response in the form of json.

Error

This Snap has at most one document error view and produces zero or more documents in the view. Each document contains the corresponding error record if snap is not able to process data.

Snap Settings

Label

required

The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Launch As

Shall be used to run specific tools and programs with different permissions than the user's current logon provides. %1 is the username and %2 password. For Ex: psexec -u %1 -p %2

Source Script

required

 Script in SLDB to copy on GroundPlex. Use he Fileicon to select the script. For ex: shared/CreateAccount.ps1

Dest Script Path

required

Absolute path where script shall be placed on GroundPlex. For ex: C:/PowershellScript/CreateAccount.ps1

Cmd to Execute

required

Command that shall be executed. For ex: powershell.exe C:/PowershellScript/CreateAccount.ps1

Is output JSON

Check box. If selected, the snap will consider the command output in JSON format , otherwise in String format.

Snap Execution

optional

Specifies the execution type:

  • Validate & Execute: Performs limited execution of the Snap (up to 2000 records based on Preview doc count, default is  50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.

  • Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

  • Disabled: Disables the Snap and, by extension, its downstream Snaps.

Default value: Execute only