Neurons Bots Stages
Stages are used to build a bot. On the Neurons Bot editor page drag a stage on to the work area. The Stage settings panel displays for you to define the settings for the action or query. The stages must be connected to create the workflow in the bot, refer to Connection settings. You can select a stage from the Stages categories. You can also create Custom stages and User stages for use with the bot.
Used to present and filter information from devices that meet the specified criteria. The output and context from this query stage can be passed through subsequent stages in the bot.
For example, show devices with less than 10% free disk space.
- Filter Results: You can filter query results based on customizable properties. Once you connect a built-in Query Stage to a Filter, the Property drop-down lists all available properties that can be selected. To view details of the properties, go to the query Stage Settings panel and select Stage Information.
- You can also use the Preview Query functionality to assess all targeted devices, and use the results table to view the format and range of values that can be filtered.
- You have the ability to join multiple queries together in sequence. If this is done, all results are combined and available to filter on, or use in Action Stages. You can change the comparison behavior of the connected filter so that it either applies either AND or the OR logic to determine the results.
- For each result of: Use this stage in conjunction with stages that return multiple results (displayed with the 'multiple' moniker) to loop an action or variable as many times as there are results for a given device.
- Join: Use this stage to re-merge a bot that has split down separate branches. In the Stage settings, select the join behavior; Any state, All succeeded, At least one succeeded.
- Set Variable: Use this stage to provide a consistent reference point that can be configured with default values and updated by stages based on results. This is useful when you want to use a single variable to reference a field which might be updated from queries across different branches. The variables that you can set are defined in Define variables.
Stages for early access are available here. Beta stages are offered to enable Ivanti to gather feedback and data around upcoming features.
Custom stages allow you to execute a custom script. You can choose from the following scripting templates:
- osquery: an open source SQL based language that can be used to query and retrieve information from devices and supports Windows and macOS devices.
- PowerShell Query: can be used to query Windows and macOS devices. It can run as system or logged-on user.
- Bash Action: can be used to perform actions on macOS devices.
- Command Action: executes Windows command prompt commands on the target endpoint. It can run as system or the logged-in user.
- Powershell Action: can be used to perform actions on Windows devices.
Learn more about Custom Stages
User stages are custom scripted stages. They are saved and made available in this User section for multiple reuse in bot creation.
Learn more about User Stages.
Variables can be used in the Stage settings to pass information between stages and pass the output of an action into the input of another action.
To insert a variable open the Stage settings. Any field that supports variables will display the text Ctrl + Space. Select Ctrl + Space to select and insert a variable from the list.
Bot Name: Name of the current bot.
Initiation User: Name of the user who initiated the bot. This will either be a user, or a Neurons service.
Initiation User ID: User ID of the initiating user. This will either be a user ID, or a Neurons service.
Timestamp (ISO): Current timestamp in ISO format.
Device Name: Gets the device name for current device within the current stage. Device names returned are separated by commas.
All Device Data: Gets all data for current device within the current stage. This will be a JSON object.
Given Name: Name of the logged on end user.
Display Name: Full name of the end user.
Email: Email for the end user.
When you drag a stage onto the work area and it is highlighted, the Stage settings panel displays. Use the settings to configure and customize each stage.
You can customize the settings by using the User Stage scripting function. Learn more about User Stages.
Each stage is given a unique numerical ID. If the bot uses the same stage more than once, this ID can be used to identify the stages individually.
Click View stage information to display the Stage Information panel, which shows a description of the stage and all the associated properties. These can be used as criteria to filter the query results.
If the settings for a stage have not been set correctly, or some information is missing, the stage will have a red border, as will the setting that needs attention. Once the setting has been correctly completed the red border is removed.
If a newer version of a stage in a bot is available, a yellow banner displays Action required: This bot contains x stage that has been deprecated. The border of the deprecated stage will be yellow.
Select Update to upgrade the stage to the newer version. Once complete, the banner is dismissed and the stage border will no longer be yellow.
If a stage in a bot has been deleted and is no longer available, a red banner displays Action required: This bot contains x stage that has been disabled. The border of the disabled stage will be red.
You must remove the stage from the bot. Once complete the banner is dismissed.
Use the Pinned category to group your most-used stages.
To pin a stage, hover over the stage, select the pin icon .
To unpin a stage, click the pinned icon .
Use the information icon on any stage to display a description of what the stage does, operating system specific information, and settings details.