Visual TOM Remote Agent

 

This repository contains the configuration files for the Visual TOM Remote Agent, that allows to execute scripts on remote servers without the need to install the Visual TOM agent.

Disclaimer

No Support and No Warranty are provided by Absyss SAS for this project and related material. The use of this project's files is at your own risk.

Absyss SAS assumes no liability for damage caused by the usage of any of the files offered here via this Github repository.

Consultings days can be requested to help for the implementation.

Prerequisites

• Visual TOM 7.2.1 or greater
• SSH configured on the Agent (using config file or SSH key)

Instructions

Create and deploy the batch queue

• Create the batch queue queue_ssh in the GUI
• Create the batch queue on the Agent (it can be the local Agent or any other Agent that has the SSH configured) with the file tom_submit.ssh

Create the remote agent

To use this feature, you need to create an agent that will be used to execute the scripts on the remote server as a gateway.

• Alias : The alias of the remote agent
• Server : The server where the agent is installed and the SSH is configured

The remote agent requires the following environment variables to be set (you can set them in the Agent variables):

• SSH_SERVER : Remote server which can be the alias used in the config file or the IP address or hostname(mandatory)
• SSH_BIN : SSH binary (optional, default: ssh)
• SSH_PORT : SSH port (optional, default: 22)
• SSH_USER : SSH user (optional, default: VTOM submit user)
• SSH_KEY : SSH key (optional, default: none)
• SSH_OPTIONS : SSH options (optional, default: none)
• SSH_DEBUG : Debug mode to display more information (optional, default: false). Enable it with 1,o,y,yes,true,oui (case insensitive).
• SSH_LOCAL_SCRIPT : The script to execute on the remote server is stored on the agent (optional, default: false). Enable it with 1,o,y,yes,true,oui (case insensitive).

Create the Job using the remote agent

• Create the Job using the remote agent with the following configuration:
  • Submit Unit : The submit unit containing the remote agent
  • Queue : The batch queue queue_ssh
  • Script : The script to execute (can be a remote script or an internal script)
  • Arguments : The arguments to pass to the script

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details

Code of Conduct

Absyss SAS has adopted the Contributor Covenant as its Code of Conduct, and we expect project participants to adhere to it. Please read the full text so that you can understand what actions will and will not be tolerated.