---
sourceDocument: Yokohama IT Operations Management
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/yokohama/it-operations-management

 Release :

    - yokohama

ft:locale :

    - en-US

ft:publication_title :

    - Yokohama IT Operations Management

ft:clusterId :

    - itom

bundleId :

    - itom

workflow :

    - Technology


---

# SCPRelay probe

# SCPRelay probe {#ariaid-title1}

* Release version: Yokohama
* 
* Updated January 30, 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute to read

The SCP Relay Probe copies a single file or the contents of a
directory from one host to another, using the MID Server as a relay.
The SCP Relay probe uses the same parameters as SSHCommand. The commands may be sent in or
out of the context of a terminal (tty), and with or without sudo
(for
those commands, such as lsof, that require being executed in the context of root to cough up
the information we need). When commands are sent in the context of a
terminal, the path is automatically widened to include a set of default paths
(and
this can be further widened with the path_override parameter). If the
target machine is the local machine, SSH is not used; instead, a local shell is run to
execute the command.
For instructions on configuring probe parameters, see [Set probe parameters](https://servicenow-prod.fluidtopics.net/UHZBnXmoydOuoy0I74kSWA "Use probe parameters to control the behavior of a particular probe every time it is triggered.").  
The following parameters may be passed to the SCP Relay probe:{#r_SCPRelayProbe__table_mw2_yqr_np__entry__3}

| Parameter | Description | Default Value |
|-|-|-|
| debug | Enables debug logging. | false |
| debug_ssh | Enables J2SSH debug logging agent.log Note: This log file can grow quickly and should be disabled when not needed. | false |
| timeout | Sets the socket connection timeout, in ms. | 60000 |
| path_override | Overrides the default paths set before executing a command. | none |
| keyboard_interactive | If true, forces the use of keyboard_interactive SSH login mode. | false |
| must_sudo | If true, forces the command to be executed through sudo. | false |
| run_in_terminal | If false, disables SSH commands from running in an SSH terminal (this will break many commands). | true |
| long_runner | If present, indicates a long-running SSH command. | false |
| set_path | If false, disables setting the path environment variable before running the command. | true |
| rm_override | If present, overrides the default rm command ("/sbin/rm -f") with the provided value. | none |
| source | Source host or IP to copy from. | required |
| source_port | SSH port on the source (defaults to 22). | required |
| from_file | Name of the file to copy from the source. | required |
| target | Target host or IP to copy to. | required |
| target_port | SSH port on the target (defaults to 22). | required |
| to_file | Name of the file to copy to the target. | required |
[Table 1. Parameters]

{#r_SCPRelayProbe__table_mw2_yqr_np}