---
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


---

# SSHCommand parameters

# SSHCommand parameters {#ariaid-title1}

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

Several parameters are available for the SSHCommand probe.
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.").  
{#r_Parameters__table_kdv_bcm_vp__entry__2}{#r_Parameters__credentials_debug}

| Parameter | Description |
|-|-|
| allow_unsupported_shells | Allows a probe designer to attempt to run a command on a device that does not have a supported shell. With no shell, the following is true: * No path information can be provided. * No scripts can function, because there is no ability to handle script parameters. * The text that is specified in the ECC queue name field of the probe form is the raw command that is run on the device. {#r_Parameters__ul_j5c_z2b_cr} For example, you may design a probe to display the version of a Cisco switch running NX-OS. The command that the switch understands is `show version`. To accomplish this, put the `show version` command in the ECC queue name field, and add the parameter name `allow_unsupported_shells` with a value of true. This parameter is only effective for `sncssh`. It is not supported with j2ssh. Currently supported shells are sh, bash, ksh, csh, and tcsh. * Type: string, true or false * Default value: false {#r_Parameters__ul_rjx_lcm_vp} |
| source | \[Required\] Specifies the initial host to connect to. * Type: string (URL) * Default value: None {#r_Parameters__ul_ggh_v2b_cr} |
| port | Specifies the target port to connect to. * Type: integer (port) * Default value: 22 {#r_Parameters__ul_vb5_ncm_vp} |
| debug | Specifies whether to write SSH debug information to the log file. The parameter usage depends on whether the ServiceNow SSH client is enabled. When the ServiceNow SSH client is enabled, this parameter functions as follows: * Type: string * Default value: false The following string values are valid for the ServiceNow SSH client: * true: Enables SSH debug information in the log file. * false: Disables SSH debug information in the log file. * \<IP Addresses\>: Specifies which IP ranges to enable SSH debug information in the log file. You can enter IP addresses in the following formats: * An IP range defined by a slash and the number of bits in the subnetwork. For example, the string 10.10.10.0/24 scans 24 bits of IP addresses from 10.10.10.0 to 10.10.10.254. * An IP range defined by a dash. For example, the string 10.10.11.0-10.10.11.165 scans the IP addresses from 10.10.11.0 to 10.10.11.165. * A comma-separated list of specific IP addresses. For example the string 10.10.11.200,10.10.11.235 scans the IP addresses 10.10.11.200 and 10.10.11.235. {#r_Parameters__ul_ymr_zcm_vp} * deferred: Specifies to log SSH debug information in memory unless an error or warning occurs. If an error or warning occurs, the platform publishes the debug information to the log file. This ensures that only the part of the log file pertaining to the error or warning is recorded. If no error or warning is detected, the platform deletes the unused log data from memory when the session closes. Each session stores up to 1000 log messages. If the session exceeds 1000 log messages, the deferred log discards the oldest log message to make room for the newest log message. {#r_Parameters__ul_oyx_wcm_vp} {#r_Parameters__ul_npx_tcm_vp} When the ServiceNow SSH client is disabled, this parameter enables or disables SSH debug information in the log file: * Type: true \| false * Default value: false {#r_Parameters__ul_rqy_2dm_vp} |
| debug_ssh | Specifies whether the legacy SSH client writes debug information into the `agent/logs/agent.log` log file. Note: This log file can grow quickly and should be disabled when not needed. The ServiceNow SSH client does not use this parameter. * Type: true \| false * Default value: false {#r_Parameters__ul_etl_kdm_vp} |
| timeout | Sets the socket connection timeout for the legacy SSH client. The ServiceNow SSH client does not use this parameter. * Type: integer (milliseconds) * Default value: 60,000 {#r_Parameters__ul_hgz_ndm_vp} |
| path_override | Specifies how to change the default paths set before executing a command. Type one or more override paths delimited by a colon (:). The default path is /usr/sbin: /usr/bin: /bin: /sbin. The ServiceNow SSH client accepts the following prefixes in front of the path_overide value: * append: Appends the override path to the end of the host's path. This is the default behavior. * replace: Replaces the host path with the path_overide value. * prepend: Appends the override path to the front of the host path. {#r_Parameters__ul_jtg_sdm_vp} * Type: string (a colon-separated list of directories) * Default value: None {#r_Parameters__ul_bwg_vdm_vp} |
| keyboard_interactive | Determines whether to enforce keyboard_interactive SSH login mode. * Type: true \| false * Default value: false {#r_Parameters__ul_ibc_ydm_vp} |
| must_sudo | Determines whether SSH commands run through sudo. Note: must_sudo probe parameter affects all patterns. On Unix or Linux hosts, pattern execution can run many different commands, some should not have sudo appended. * Type: true \| false * Default value: false {#r_Parameters__ul_wyw_b2m_vp} |
| run_in_terminal | Determines whether SSH commands run in an SSH terminal. * Type: true \| false * Default value: * ServiceNow SSH client: false * Legacy SSH client: true {#r_Parameters__ul_ykj_g2m_vp} {#r_Parameters__ul_mkf_f2m_vp} |
| set_path | Determines whether the probe is allowed to alter the session's PATH variable or not. By default, during session setup, the PATH variable is set to `/usr/sbin:/usr/bin:/bin:/sbin`. * Type: true \| false * Default value: true {#r_Parameters__ul_asb_k2m_vp} |
| rm_override | Overrides the default remove command `(/bin/rm -f)` with the provided value. * Type: string * Default value: none {#r_Parameters__ul_j3m_m2m_vp} |
| use_snc_ssh | Enables the ServiceNow SSH client. The ServiceNow SSH client is active by default on new instances. Enabling the ServiceNow SSH client disables the legacy SSH client. * Type: true \| false * Default value: true {#r_Parameters__ul_s5y_p2m_vp} |
| command_timeout_ms | Number of milliseconds an SSH command is allowed to run before timing out (default is configurable per MID server). The legacy SSH client does not use this parameter. * Type: integer * Default value: value of the mid.ssh.command_timeout_ms MID Server parameter. {#r_Parameters__ul_gd2_w2m_vp} |
| channel_timeout_ms | Specifies the amount of time, in milliseconds, that a MID Server waits for activity during processing of an SSH command. If the MID Server does not detect activity in the specified timeout window, this parameter kills the command. * Type: integer (milliseconds) * Default value: 300000 (5 minutes) {#r_Parameters__ul_dbs_nbf_xp} |
| preserve_sudo_environment | Specifies whether to use sudo to preserve the environment for SSH. This parameter is only effective if the sudo environment on the host being probed supports the `-E` switch. * Type: true \| false * Default value: false {#r_Parameters__ul_xsz_ffm_vp} |
| credentials_debug | Displays a \<credentials_debug\> section in the ECC queue, which can help you troubleshoot credentials. If you set this property to true, credential troubleshooting information is output to the ECC queue, even if the credentials succeed. See [Credentials Troubleshooting](https://www.servicenow.com/docs/access?context=r_CredentialTroubleshooting&version=yokohama&pubname=yokohama-platform-security&ft:locale=en-US) for more information. |
[Table 1. Parameters Table]

{#r_Parameters__table_kdv_bcm_vp}