PowerShell Action

Creating an Action Using Action Type: PowerShell

Overview

This document provides step-by-step instructions for creating and configuring an action using the PowerShell action type in Callgoose SQIBS automation platform. The PowerShell action type allows users to execute PowerShell scripts for automation workflows. Below are the configuration options and their descriptions:

Steps to Add a PowerShell Action

1. Navigate to Add Action

• Access the automation section in the Callgoose SQIBS automation platform.
• Go to Automation, and you can see Action.
• Click on Action and then click on Add Actions to create a new action.

1. Select Action Type

• Choose PowerShell as the action type from the list of available options.

1. Copy from Existing Actions

• Copy From:
• Click on Copy From to copy an existing action.
• You can copy actions from:
• Callgoose Actions: Predefined task-based scripts and programs available free of charge.
• Team Actions: Actions shared within your team.
• Global Actions: Actions available globally across the platform.
• Callgoose Actions provide several task-based scripts and programs that you can use and modify according to your requirements.

1. Fill in the Details

• Name*:
• Provide a descriptive name for the action.
• Example: Check Disk Space.
• Description*:
• Add a detailed description of what the action does.
• Example: This action runs a PowerShell script to check available disk space on a Windows server.
• Version:
• Select the required PowerShell version.
• Example: 7.4.5.
• Success Response*:
• Define the expected output when the script runs successfully. The success response is similar to the exit status in Linux.
• Example: 0 exit status indicates the script or command executed successfully.

1. Configure Arguments

• Have Argument:
• Choose whether the action requires arguments.
• Yes: Enables input fields to define arguments for the script.
• No: Indicates that no arguments are required.

1. Set Expected Run Time

• Expected Run Time (in Minutes)*:
• Specify the estimated time for the execution.
• Example: 10 (indicating 10 minutes).

1. Upload the PowerShell File

• PowerShell File:
• Upload the PowerShell script file to be executed.
• Click on File Upload and select the script from your local system.
• Click on Save to finalize the action.

Additional Notes

• Fields marked with an asterisk (*) are mandatory.
• Ensure the PowerShell script is tested locally before configuring the action to avoid runtime errors.
• Use descriptive names and success responses to make it easier for team members to understand the action.
• The "Expected Run Time" should be realistic to help with workflow monitoring and optimization.

Example Configuration

Name: Check Disk Space

Description: This action runs a PowerShell script to check available disk space on a Windows server.

Version: 7.4.5

Success Response: 0 (indicating the script executed successfully).

Have Argument: No

Expected Run Time (in Minutes): 10

PowerShell File: Upload a file named CheckDiskSpace.ps1

Conclusion

By following these steps, you can effectively configure and execute a PowerShell action in Callgoose SQIBS automation platform. This capability enhances the automation of Windows server tasks and simplifies workflow management.