SSH Action

Creating an Action Using Action Type: SSH

Overview

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

Steps to Add an SSH 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 SSH 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 Usage.
• Description*:
• Add a detailed description of what the action does.
• Example: This action checks the disk usage on a remote server using SSH.
• OS Command:
• Type the operating system command to execute via SSH.
• Example: df -hT (to check disk usage in Linux).
• Success Response*:
• Define the expected output when the command 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 command.
• No: Indicates that no arguments are required.

1. Set Expected Run Time

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

Additional Notes

• Fields marked with an asterisk (*) are mandatory.
• Ensure the OS command is tested locally on the target system 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 Usage

Description: This action checks the disk usage on a remote server using SSH.

OS Command: df -hT

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

Have Argument: No

Expected Run Time (in Minutes): 5

Conclusion

By following these steps, you can effectively configure and execute an SSH action in Callgoose SQIBS automation platform. This capability enhances the automation of system administration tasks and simplifies workflow management.