Skip to content

Bots From Extension: ssh

SSH - Connect and Execute commands on SSH Nodes

This extension provides 6 bots.





Bot @ssh:execute

Bot Position In Pipeline: Source Sink

Execute the command on the ssh node and get status, output and errors

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
ipaddress* Text IP Address to connect with ssh
command* Text Command to execute on the ssh node







Bot @ssh:read-data

Bot Position In Pipeline: Source Sink

Read dataframe from ssh node with specified filename

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
ipaddress* Text IP Address to connect with ssh
filename* Text Filename on the ssh node
format Text auto Data format. Must be one of 'csv' or 'json'. If 'auto', determine it using the filename's extension







Bot @ssh:read-directory

Bot Position In Pipeline: Source Sink

Read multiple files from a given directory on ssh node

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
ipaddress* Text IP Address to connect with ssh
directory* Text Directory on the ssh node
files* Text Filename pattern (regex) on the ssh node







Bot @ssh:read-file

Bot Position In Pipeline: Source Sink

Read a single file form ssh node

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
ipaddress* Text IP Address to connect with ssh
filename* Text Filename on the ssh node







Bot @ssh:write-data

Bot Position In Pipeline: Sink

Write the input dataframe to ssh node with specified filename

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
ipaddress* Text IP Address to connect with ssh
filename* Text Filename on the ssh node
format Text auto Data format. Must be one of 'csv' or 'json'. If 'auto', determine it using the filename's extension







Bot @ssh:write-files

Bot Position In Pipeline: Sink

Write each input row as file on ssh node. Expects 'filename' and 'data' columns

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
ipaddress* Text IP Address to connect with ssh
filename_column Text filename Filename on the ssh node
data_column Text data File contents to be written to ssh node