CustomCommand

Kovair DevOps CustomCommand Integration Plugin

CustomCommand
Listen to this article

CustomCommand Plugin Details

Plugin Version: 1.0.1
Last Update on: March 25, 2020

Overview

 CustomCommand provides provision to run commands in any format.

CustomCommand Information:

CustomCommand supports execution of the following command types:.

  • Powershell
  • CMD Command
  • SQL Command
  • Shell Command
  • MariaDB Command
  • Oracle Command

Version Supported:

Not Application

Plugin Operation:

  1. ExecuteCMDCommand / ExecuteInPowershell / ExecuteShellCommand
  2. This operation allows to execute custom commands;.
    Input parameter(s):

    ParameterIs MandatoryHelp Text
    CommandtruePut the command to execute Note: Must have administrator access
    Output Parameter(s):

    ParameterHelp Text
    CommandOutputOutput of the command.
    CommandStatusFinal command job status.
    Pass/Fail Condition:

    StatusRequired string in outputlog
    PassedIf the output log is empty or does not contains any string mentioned in failed section.
    FailedIf 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’
  3. ExecuteSQLCommand
  4. This operation allows to execute SQL commands;.
    Input parameter(s):

    ParameterIs MandatoryHelp Text
    Server Nametruegive the server name
    Authenticationtruemetion the authentication type WINDOWS/SQL
    User NamefalseIf windows type authentication, no need to provide this field value
    PasswordfalseIf windows type authentication, no need to provide this field value
    DB NametrueDB to be connected
    Execution File PathfalseMention the full path of the file to be executed.Ex: C:\Scripts\Script1.sql
    Execution CommandfalseSplit the multiple command with ‘;’ to be executed. Ex: Select * from tusers
    Output Parameter(s):

    ParameterHelp Text
    CommandOutputOutput of the command
    CommandStatusFinal command job status.
    Pass/Fail Condition:

    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) ‘Cannot open database’
    2) ‘Login failed for user’
    3) ‘Server is not found or not accessible’
    4) ‘Invalid object name’
    5) ‘Could not find stored procedure’
    6) ‘Incorrect syntax near’
    7) ‘syntax error’
    8) ‘Invalid column’
    9) ‘Invalid filename’
    10) ‘Could not find’
    11) ‘Invalid column’

  5. ExecuteMariaDBCommand
  6. This operation allows to execute MariaDB commands;.
    Input parameter(s):

    ParameterIs MandatoryHelp Text
    Server Nametruegive the server name
    User NametrueProvide user name to log into MariaDB server
    PasswordtrueProvide password to log into MariaDB server
    DB NametrueDB to be connected
    Execution File PathfalseMention the full path of the file to be executed.Ex: C:\Scripts\Script1.sql
    Execution CommandfalseSplit the multiple command with ‘;’ to be executed. Ex: Select * from tusers
    Output Parameter(s):

    ParameterHelp Text
    CommandOutputOutput of the command
    CommandStatusFinal command job status.
    Pass/Fail Condition:

    StatusRequired string in outputlog
    PassedOutput of the command
    FailedIf 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’
  7. ExecuteOracleDBCommand
  8. This operation allows to execute Oracle DB commands;.
    Input parameter(s):

    ParameterIsMandatoryHelp Text
    Server Nametruegive the server name
    Porttruegive the port number
    User NametrueProvide user name to log into Oracle DB server
    PasswordtrueProvide password to log into Oracle DB server
    DB NametrueDatabase SID
    Execution File PathfalseMention the full path of the file to be executed..Every statement must end with a semi-colon (;).Ex: C:\Scripts\Script1.sql
    Execution CommandfalseOnly 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;
    Output parameter(s):

    ParameterHelp Text
    CommandOutputOutput of the command
    CommandStatusFinal command job status.
    Pass/Fail Condition:

    StatusRequired string in outputlog
    PassedOutput of the command
    FailedIf 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:

  1. User must have administrative access.
  2. For windows type authentication- Ignore username and password field value, keep these parameters blank.
  3. ExecuteSQLCommand – Username and password must be specified for SQL type authentication.
  4. ExecuteSQLCommand – Mention the full path of the file to be executed.If this path is provided then ‘Execution Command’ is not required.
  5. ExecuteSQLCommand – Username and password must be specified for SQL type authentication.
  6. ExecuteSQLCommand – Split the multiple command with ‘;’ to be executed.
  7. 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.
  8. 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:

CustomCommand: 1.0.1
Initial version with basic functionalities.

Contact us:

Yes, I accept the Privacy Statement and want to receive latest information from Kovair.

EnglishFrenchGermanItalianJapaneseSpanishChinese (Simplified)