GoreloAction CLI (via PowerShell) - Gorelo Documentation

GoreloAction is a command-line utility that automatically comes with the Gorelo Agent when you install it on an asset. GoreloAction enables PowerShell scripts to interact with Gorelo. It currently supports:

Generating alerts.
Writing to custom asset fields.

Use GoreloAction

Generate alerts
Write to custom asset field

Run the following command in your terminal, and replace <String> with the parameter values:

GoreloAction -Alert -Severity <Int> -Name <String> -Description <String> -Suppress <Int>

Parameters

Option	Description
`-Alert`	Specifies alert creation mode.
`-Severity`	Sets the severity level (Integer) 1: Critical 2: Error 3: Warning
`-Name`	Title/name of the alert in Gorelo.
`-Description`	Detailed description of the alert in Gorelo (optional).
`-Suppress`	Alert suppression duration in hours (optional and defaults to 4, use 0 for no suppression).

Example

GoreloAction -Alert -Severity 1 -Name "NameHere" -Description "DescriptionHere" -Suppress 0

Run the following command in your terminal, and replace <String> with the parameter values:

GoreloAction -SetCustomField -Name <String> -Value <String>

Parameters

Option	Description
`-SetCustomField`	Specifies custom field write mode.
`-Name`	Field identifier: Format: `'asset.fieldname'` Remove `$gorelo`: from the variable
`-Value`	Data to store in the field.

Example

GoreloAction -SetCustomField -Name 'asset.rustdeskPassword' -Value "SecurePassword123"

⌘I