This shows you the differences between two versions of the page.
script_generic_adaptor [2018/09/19 11:21] tast created |
script_generic_adaptor [2025/03/07 10:07] (current) ale |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ===== Script Generic Adaptor ===== | + | ====== Script Generic Adaptor ====== |
- | {{:TAST-icon.png?nolink&70|}} | ||
- | ==== Introduction ==== | + | ===== Introduction ===== |
This Adaptor is used for executing scripts on remote or local machines, doesn't matter the Operative System is running in that machine. | This Adaptor is used for executing scripts on remote or local machines, doesn't matter the Operative System is running in that machine. | ||
- | ==== Setup ==== | + | ===== Setup ===== |
In the initialization process, it's necessary to provide the information to connect with the machine. That is the Adaptor's information: | In the initialization process, it's necessary to provide the information to connect with the machine. That is the Adaptor's information: | ||
- | ==== Initialization Parameters ==== | + | ===== Initialization Parameters ===== |
- | * **Host address:** Ip addres of the Host machine. | + | * **User:** user name authorized to access to the Host machine. |
- | * **Username:** User name authorized to access to the Host machine. | + | * **Password:** password of a user authorized to access to the Host machine. |
- | * **Password:** Password of a user authorized to access to the Host machine. | + | * **Host:** IP address of the Host machine. |
- | * **Port:** Port for the Ip addres of the Host machine. | + | * **Port:** port for the IP address of the Host machine. |
- | * **Connection Type:** Type of connection to the Host machine. For example, SSH (Secure connection). | + | * **Connection_Type:** type of connection to the Host machine. For example: SSH (Secure connection). |
- | ==== Functions ==== | + | ===== Functions ===== |
- | * **connect_Script:** Makes an attempt to connect to the SSH server. Returns true if it succeeds or false otherwise. | + | * **connect_Script():** makes an attempt to connect to the SSH server. Returns true if it succeeds or false otherwise. It does no requires parameters as it utilizes the adaptor ones. |
| | ||
- | * **disconnect_Script:** Performs disconnection of the SSH server. Returns true if it succeeds or false otherwise. | + | * **disconnect_Script():** performs disconnection of the SSH server. Returns true if it succeeds or false otherwise. It does no requires parameters. |
+ | |||
+ | * **execute_Script(Script):** gets the command that allows you to execute the script. Returns a String with the result of the script execution. It generates a file “ScriptResultsStep.txt” in the same directory as the logs, if evidence has been requested. | ||
+ | |||
+ | * **newConnect_Script(Username, Password, Host, Port, Connection_Type):** allows defining a new connection with a different SSH server, using the same parameters that are used in the initialization of the Adapter. Returns true if successful or false otherwise. | ||
- | * **execute_Script(Script):** Picks up the command that allows you to execute the script. Returns true if the execution was successful or false otherwise. Leave the result in an output file in the execution Log along with the ScreenShots if they have been requested. | ||
- | * **newConnect_Script(Username, Password, Host, Port, Connection_Type):** Allows defining a new connection with a different SSH server. Using the same parameters that are used in the initialization of the Adapter. Returns true if successful or false otherwise. |