Linux

Linux



Linux 

Linux plugin has been tested on,

Red Hat: Red Hat Enterprise Linux Server release 7.0 (Maipo) and Ubuntu: Ubuntu 16.04

Prerequisites:

Root user (administrator) can execute all the steps. However, for normal user consider the following,


In case of Red Hat Enterprise Linux Server release 7.0 (Maipo), when you want to run a command that requires root rights, Linux checks your username against the sudoers file.  Linux is built with security in mind. The sudoers file is a file Linux Administrators use to allocate system rights to system users. This allows the administrator to control who does what. Necessary user entry is required in the ‘sudoers’ file and also, the ‘sudoers’ file must have the neccessary permissions to make these changes.

However, on Debian based systems e.g. Ubuntu if your process is started by super user, we won't be able to kill that process using this plugin because Ubuntu does not allow direct access to super user processes. This is applicable to Ubuntu 16.04 mentioned above.


Linux: Add User

Description

This Linux plugin step is used to create a new user in Linux operating system.

Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name  

Server IP of the Linux/Ubuntu Machine. This field is mandatory. Drop down is available.

4

Port

The port number on which Machine is running. 22 is the default port. This field is mandatory.

5

Username

The username of the Linux / Ubuntu Machine (Root). Refer Prerequisites regarding user in the introduction to this plugin.

This field is mandatory. 


Password:


6

Checkbox: Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

7

Password

The Password of the Linux/ Ubuntu Machine username to authenticate into the system. 


Password is entered using a widget. The widget handles both TextVar(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Input Section:

No.

Field Name

Description


Input Fields:


1

New Username

The name of the new user to be created. This field is mandatory. 

2

New Password

The password of the new user to be created. This field is mandatory.


Output Section:

No.

Field Name

Description


Output Fields:


1

Result

Output field to hold the result of the successful plugin execution.

Default label value for this field is “Result”. This field is mandatory.


The error can be captured in error handling as discussed in Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.



Linux: Kill Process

Description

This step is used to kill a process on Linux OS based on the provided Process ID. There is an option provided for the user to forcefully kill a Process. The user has to select Yes or No from the dropdown. Forcefully kill will always work provided the user has the permission to kill the process. 


Configuration

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name  

Server IP of the Linux/Ubuntu Machine. This field is mandatory. Drop down is available.

4

Port

The port number on which Machine is running. 22 is the default port. This field is mandatory.

5

Username

The username of the Linux / Ubuntu Machine (Root). Refer Prerequisites regarding user in the introduction to this plugin.

This field is mandatory. 


Password:


6

Checkbox: Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

7

Password

The Password of the Linux/ Ubuntu Machine username to authenticate into the system. 


Password is entered using a widget. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Input:

No.

Field Name

Description


Input Fields:


1

Process ID

Holds the Process ID of the Process that has to be deleted. This field is mandatory.

2

Kill Forcefully

The Field is dropdown. User can select either Yes or No from the dropdown.


Output:

No.

Field Name

Description


Output Fields:


1

Result

Output field to hold the result of the successful plugin execution.

Default label value for this field is “Result”. This field is mandatory.


The error can be captured in error handling as discussed in Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.


NOTE:

This Plugin kills the process running on the Linux Machine by taking the Process ID as the input. By any chance if the status of that particular process is still active after successful execution of Plugin then there might be few possibilities.

  1. That particular Process is under the execution of system call(). It will be terminated once it finishes its execution.
  2. That Process is a Zombie Process. There is no harm if it is still alive, just try killing the Parent Process, it will be automatically terminated.
  3. You are not the owner of that Process.


Linux: Start Service

Description

This plugin is designed to start Linux Service.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name  

Server IP of the Linux/Ubuntu Machine. This field is mandatory. Drop down is available.

4

Port

The port number on which Machine is running. 22 is the default port. This field is mandatory.

5

Username

The username of the Linux / Ubuntu Machine (Root). Refer Prerequisites regarding user in the introduction to this plugin.

This field is mandatory. 


Password:


6

Checkbox: Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

7

Password

The Password of the Linux/ Ubuntu Machine username to authenticate into the system. 


Password is entered using a widget. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Input:

No.

Field Name

Description


Input Fields:


1

Service Name

The name of the service to be started. This field is mandatory.

2

Maximum time out (in seconds)

Execute the plugin up to given maximum time.

3

Check cycle time (in seconds)

Check cycle time up to given maximum time


Output:

No.

Field Name

Description


Output Fields:


1

Result

Output field to hold the result of the successful plugin execution.

Default label value for this field is “Result”. This field is mandatory.


The error can be captured in error handling as discussed in Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.


Linux Stop Service

Description

This plugin is designed to stop Linux Service.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name  

Server IP of the Linux/Ubuntu Machine. This field is mandatory. Drop down is available.

4

Port

The port number on which Machine is running. 22 is the default port. This field is mandatory.

5

Username

The username of the Linux / Ubuntu Machine (Root). Refer Prerequisites regarding user in the introduction to this plugin.

This field is mandatory. 


Password:


6

Checkbox: Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

7

Password

The Password of the Linux/ Ubuntu Machine username to authenticate into the system. 


Password is entered using a widget. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Input:

No.

Field Name

Description


Input Fields:


1

Service Name

The name of the service to be stopped. This field is mandatory.

2

Maximum time out (in seconds)

Execute the plugin up to given maximum time.

3

Check cycle time (in seconds)

Check cycle time up to given maximum time


Output:

No.

Field Name

Description


Output Fields:


1

Result

Output field to hold the result of the successful plugin execution.

Default label value for this field is “Result”. This field is mandatory.


The error can be captured in error handling as discussed in Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.




Linux Restart Service

Description

This plugin is designed to restart Linux Service.



Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name  

Server IP of the Linux/Ubuntu Machine. This field is mandatory. Drop down is available.

4

Port

The port number on which Machine is running. 22 is the default port. This field is mandatory.

5

Username

The username of the Linux / Ubuntu Machine (Root). Refer Prerequisites regarding user in the introduction to this plugin.

This field is mandatory. 


Password:


6

Checkbox: Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

7

Password

The Password of the Linux/ Ubuntu Machine username to authenticate into the system. 


Password is entered using a widget. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.


If checkbox above is enabled Password field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.


Input:

No.

Field Name

Description


Input Fields:


1

Service Name

The name of the service to be restarted. This field is mandatory.

2

Maximum time out (in seconds)

Execute the plugin upto given maximum time.

3

Check cycle time (in seconds)

Check cycle time up to given maximum time


Output:

No.

Field Name

Description


Output Fields:


1

Result

Output field to hold the result of the successful plugin execution.

Default label value for this field is “Result”. This field is mandatory.


The error can be captured in error handling as discussed in Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.






      Links to better reach 

            Bot Store

             EPD