Ansible Action

Creating an Action Using Action Type: Ansible

Overview

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

Steps to Add an Ansible 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 Ansible 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: Run Ansible Playbook.
• Description*:
• Add a detailed description of what the action does.
• Example: This action executes an Ansible playbook to configure servers.
• Version:
• Select the required Ansible version.
• Example: Ansible 2.17.
• Success Response*:
• Define the expected output when the playbook or 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. Choose Ansible Operation

• Playbook:
• Playbook Options:
• Specify the options for the Ansible playbook, such as variables or limiting target hosts. Refer to the tooltip for more information.
• Playbook File:
• Upload the playbook file to be executed.
• Add Commands:
• Add commands to be executed after the playbook execution.
• You can add multiple commands by clicking the + symbol.
• Command:
• Add Commands:
• Add Ansible ad-hoc commands to be executed.
• In this case, only the ad-hoc commands specified here will be executed.
• You can add multiple commands by clicking the + symbol.

1. Configure Arguments

• Have Argument:
• Choose whether the action requires arguments.
• Yes: Enables input fields to define arguments for the playbook or command.
• 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 Multiple Files

• If you have multiple files to upload:
• First, create the action.
• Then, open that action.
• Click on Show Details.
• Click on Edit, and you will be able to see the Other Files option.
• Upload the additional files as required by your playbook.
• Click on Save after uploading the files if necessary.

Additional Notes

• Fields marked with an asterisk (*) are mandatory.
• Ensure the Ansible playbook or commands are 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: Run Ansible Playbook

Description: This action executes an Ansible playbook to configure servers.

Version: Ansible 2.17

Success Response: 0 (indicating the playbook or commands executed successfully).

Operation: Playbook

Playbook File: Upload a file named server_setup.yml.

Add Commands: Add post-playbook commands such as ansible-playbook cleanup.yml.

Have Argument: Yes

Expected Run Time (in Minutes): 10

Conclusion

By following these steps, you can effectively configure and execute an Ansible action in Callgoose SQIBS automation platform. This capability enhances the automation of IT operations and simplifies workflow management.