CustomCommand Plugin Details
Overview
CustomCommand Information:
CustomCommand supports execution of the following command types:.
- Powershell
- CMD Command
- SQL Command
- Shell Command
- MariaDB Command
- Oracle Command
Version Supported:
Plugin Operation:
- ExecuteCMDCommand / ExecuteInPowershell / ExecuteShellCommand
- ExecuteSQLCommand
- ExecuteMariaDBCommand
- ExecuteOracleDBCommand
Parameter | Is Mandatory | Help Text |
Command | true | Put the command to execute Note: Must have administrator access |
Parameter | Help Text |
CommandOutput | Output of the command. |
CommandStatus | Final command job status. |
Status | Required string in outputlog |
Passed | If the output log is empty or does not contains any string mentioned in failed section. |
Failed | If the output log is not empty and contains any of the following: 1) ‘is not recognized as an internal or external command’ 2) ‘ERROR’ 3) ‘FullyQualifiedErrorId’ 4) ‘command not found’ 5) ‘No such file or directory’ |
Parameter | Is Mandatory | Help Text |
Server Name | true | give the server name |
Authentication | true | metion the authentication type WINDOWS/SQL |
User Name | false | If windows type authentication, no need to provide this field value |
Password | false | If windows type authentication, no need to provide this field value |
DB Name | true | DB to be connected |
Execution File Path | false | Mention the full path of the file to be executed.Ex: C:\Scripts\Script1.sql |
Execution Command | false | Split the multiple command with ‘;’ to be executed. Ex: Select * from tusers |
Parameter | Help Text |
CommandOutput | Output of the command |
CommandStatus | Final command job status. |
Status |
Required string in outputlog |
Passed |
If the output log is empty or does not contains any string mentioned in failed section. |
Failed |
If the output log is not empty and contains any of the following: |
Parameter | Is Mandatory | Help Text |
Server Name | true | give the server name |
User Name | true | Provide user name to log into MariaDB server |
Password | true | Provide password to log into MariaDB server |
DB Name | true | DB to be connected |
Execution File Path | false | Mention the full path of the file to be executed.Ex: C:\Scripts\Script1.sql |
Execution Command | false | Split the multiple command with ‘;’ to be executed. Ex: Select * from tusers |
Parameter | Help Text |
CommandOutput | Output of the command |
CommandStatus | Final command job status. |
Status | Required string in outputlog |
Passed | Output of the command |
Failed | If the output log is not empty and contains any of the following: 1) ‘Cannot open database’ 2) ‘Unknown database’ 3) ‘Login failed for user’ 4) ‘Access denied for user’ 5) ‘Server is not found or not accessible’ 6) ‘Unknown MYSQL server host’ 7) ‘Invalid object name’ 8) ‘Could not find stored procedure’ 9) ‘Incorrect syntax near’ 10) ‘syntax error’ 11) ‘Invalid column’ 12) ‘Invalid filename’ 13) ‘Could not find’ 14) ‘mysql.exe is not recognized as an internal or external command’ 15) ‘The system cannot find the file specified’ |
Parameter | IsMandatory | Help Text |
Server Name | true | give the server name |
Port | true | give the port number |
User Name | true | Provide user name to log into Oracle DB server |
Password | true | Provide password to log into Oracle DB server |
DB Name | true | Database SID |
Execution File Path | false | Mention the full path of the file to be executed..Every statement must end with a semi-colon (;).Ex: C:\Scripts\Script1.sql |
Execution Command | false | Only a single command to be executed.Statement must end with a semi-colon (;) For multple commands, put the command in .sql and use the ‘Execution File Path’ parameter.. Ex: Select * from tusers; |
Parameter | Help Text |
CommandOutput | Output of the command |
CommandStatus | Final command job status. |
Status | Required string in outputlog |
Passed | Output of the command |
Failed | If the output log is not empty and contains any of the following: 1) ‘Cannot open database’ 2) ‘The listener does not currently know of SID given in context’ 3) ‘invalid username/password’ 4) ‘command not properly ended’ 5) ‘no such protocol adapter’ 6) ‘Access denied for user’ 7) ‘Server is not found or not accessible’ 8) ‘Connect failed because target host or object does not exist’ 9) ‘Invalid object name’ 10) ‘Could not find stored procedure’ 11) ‘Incorrect syntax near’ 12) ‘syntax error’ 13) ‘Invalid column’ 14) ‘Invalid filename’ 15) ‘table or view does not exist’ 16) ‘invalid identifier’ 17) ‘sqlplus is not recognized as an internal or external command’ 18) ‘doesn’t exist’ 19) ‘The system cannot find the file specified’ |
Disclaimers:
- User must have administrative access.
- For windows type authentication- Ignore username and password field value, keep these parameters blank.
- ExecuteSQLCommand – Username and password must be specified for SQL type authentication.
- ExecuteSQLCommand – Mention the full path of the file to be executed.If this path is provided then ‘Execution Command’ is not required.
- ExecuteSQLCommand – Username and password must be specified for SQL type authentication.
- ExecuteSQLCommand – Split the multiple command with ‘;’ to be executed.
- ExecuteMariaDBCommand – MariaDB server must be installed in the system where in KovairDevops agent service is installed.‘mysql’ command must be available in the command prompt where the KovairDevops agent service is installed.All statements are executed on cmd. So output will be similar to cmd output.
- ExecuteOracleDBCommand -‘sqlplus’ command must be available in the command prompt where the KovairDevops agent service is installed.All statements are executed on cmd. So output will be similar to cmd output.
Release Details:
Initial version with basic functionalities.