Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

MID Server properties used by Service Mapping

Service Mapping uses the MID Server parameters during discovery and mapping. Do not change default values for these parameters unless you are troubleshooting the discovery process.

General properties

PropertyDescription
mid.file\_tracking.file\_path\_forbidden\_stringsComma-separated list of strings to search for in tracked file paths. Once any string in this list is found in a tracked file path, the file is removed from further processing. - Default value: job finished with status ERROR - Type: string - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
PropertyDescription
mid.sa.ssh.path

A location at the target system where the MID Server checks for commands to execute.

  • Default value: /usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
  • Type: string
  • Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.truncate\_last\_line\_regex

A regular expression of line that the MID Server removes from the end of the SSH command response.

  • Default value: Command.*performed by.*
  • Type: string
  • Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.remove\_first\_line\_regex

A regular expression of line that the MID Server removes from the start of every SSH command response.

  • Default value: [empty string]
  • Type: string
  • Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.privileged\_command\_message

A prompt the MID Server sends with commands with sudo-level privileges. For example, a sudo-level command is sent with “Password:”.

  • Default value: [empty string]
  • Type: string
  • Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.restricted\_shell\_regexA regular expression text included on opening message of a restricted shell. Using a restricted shell, the SSH provider does not run some commands during the session initialization.- Default value: restricted shell - Type: - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.terminal\_colsThe number of columns in the terminal windows opened with the SSH session.- Default value: 300 - Type: integer - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.terminal\_rowsThe number of rows in the terminal windows opened with the SSH session. - Default value: 800 - Type: integer - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.time\_between\_change\_shell\_and\_promptThe time to wait between changing a shell during initialization and the time the shell prompt appears (in milliseconds).- Default value: 1000 - Type: integer - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.connect\_timeoutThe SSH initial connection timeout (in milliseconds).- Default value: 2000 - Type: integer - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.max\_chars\_single\_responseThe maximum number of characters allowed in a single SSH command response.- Default value: 10000000 - Type: integer - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.break\_session\_charsThe ASCII value of character used to break a session.- Default value: 7 - Type: integer - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.no\_change\_shell\_regex

The regular expression of text within command response after sending ‘su’ in order to change to superuser. If the regular expression matches, the MID Server does not change the shell.

  • Default value: pfsh
  • Type: string
  • Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.permission\_denied\_regex

The regular expression of command responses which the MID Server recognizes as an access problem and generates an appropriate message.

  • Default value: permission denied
  • Type: string
  • Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.more\_line\_command\_regexWhen the SSH response exceeds the terminal size, the system sends ‘more’ line which matches the regular expression. When the MID Server recognizes the ‘more’ line, it sends the space character. This is relevant for proprietary systems sending a non-standard ‘more’ prompt.- Default value: [empty] - Type: - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.become\_superuser\_commandAn SSH command for turning into a superuser.- Default value: su - Type: string - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.prompt\_changing\_command\_regexSSH commands that change the shell prompt. When the command the MID Server sends matches the regular expression, the MID Server knows to expect a change in the server prompt.- Default value: changeto\\s+[^\\s]+ - Type: - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.ignore\_errors\_on\_commands\_regexA regular expression for the command on which the MID Server ignores permission errors.- Default value: stat.*\|istat.*\|perl.* - Type: string - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.prompt\_last\_char\_regexA regular expression of the last character in the default prompt of the server.- Default value: [$#>\\]\\:] - Type: string - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.timeoutThe SSH command timeout (in milliseconds).- Default value: 60000 - Type: integer - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.port

The SSH port number.To add more than one port, separate port numbers with a comma. For example, 22,33,44.

  • Default value: 22
  • Type: integer
  • Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.connect.retryThe SSH connection retry count.- Default value: 1 - Type: integer - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.additional\_setup

The command the MID Server sends after it creates the SSH session.

  • Default value: [empty]
  • Type: string
  • Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.expect\_after\_suA regular expression of the last character in the prompt after sendind ‘su’.- Default value: [:$#>\\]] - Type: string - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.privileged\_command\_last\_charA character indicating the last expected character in a command result String. Once this character is found in the result, the MID Server does not wait for additional output.- Default value: [empty] - Type: string - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.prompt

A string representing the non-standard SSH prompt. The MID Server uses this string when parsing results of SSH CLI commands.

  • Default value: SERVNOW>
  • Type:
  • Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.proprietary\_system\_trial\_count

Number of additional waiting periods on proprietary non-UNIX/Linux systems. The MID Server waits for a response after the initial waiting period of 5 seconds. After the initial 5 seconds, the MID Server waits for the response the number of times as defined by this parameter. The additional waiting time starts from 1 second and increases by 1 sec for every iteration.

  • Default value: 10
  • Type: integer
  • Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.restart\_after\_unstopped\_threads

The number of allowed unstopped threads before the MID Server is restarted, when it attempts to close the SSH session.

  • Default value: 50
  • Type: integer
  • Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.stty\_command

The stty command for configuring appropriate settings. The MID Server runs this command when initializing the SSH terminal.

  • Default value: [empty]
  • Type:
  • Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.inocrrect\_password\_regex

The expected string which the SSH terminal returns when the MID Server uses an incorrect password during the login process.

  • Default value: Sorry, try again\|incorrect password attempt
  • Type:
  • Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.max\_unstopped\_threadsSame as the mid.sa.ssh.restart_after_unstopped_threads parameter.- Default value: 50 - Type: integer - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.ssh.idle\_after\_sudo

The period of time (in milliseconds) that the MID Server waits after sending a sudo command and expects to have no activity on the line.

  • Default value: 3000
  • Type:integer
  • Location:This property is not available in the base system. You can add the property as described in Create a MID Server property.

Important: WMI Collector is deprecated in New York patch 10 and later. See the KB0791835 WMI Collector deprecation detailsfor more information.

PropertiesDescription
mid.servicewatch.wmi.host

The Host/IP of the server running the ServiceNow WMI collector.

  • Default value: localhost
  • Type: string
  • Location: This property is available under specific MID Server parameters as described in Add a MID Server parameter.
mid.servicewatch.wmi.portThe port on which the ServiceNow WMI collector service listens to requests from the MID server.- Default value: 8585 - Type: integer - Location: This property is available under specific MID Server parameters as described in Add a MID Server parameter.
mid.sa.wmi.timeoutThe timeout on command execution in milliseconds. This property controls also the Powershell commands.- Default value: 60000 - Type: integer - Location: This property is available under specific MID Server parameters as described in Add a MID Server parameter.
mid.sa.wmi.max\_bytes\_in\_responseThe maximum number of characters allowed in a response.- Default value: 20971520 - Type: integer - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.servicewatch.wmi.get\_file\_on\_shared\_drive\_from\_collector

The MID Server attempts to access the requested file on a shared drive directly from the MID Server.

  • Default value: true
  • Type: true/false
  • Location: This property is available under specific MID Server parameters as described in Add a MID Server parameter.
mid.sa.wmi.access\_denied\_regexThe regular expression of error messages returned by server that the MID Server considers as an access problem and triggers trying other credentials.- Default value: Access is denied\|Access denied\|service installation failed\|User credentials cannot be used for local connections\|System error 1312\|generic failure\|Insufficient privilege\|user rights\|HRESULT: 0x800706BA - Type: string - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.wmi.send\_retry\_countThe number of attempts to commiunicate with the ServiceNow WMI Collector service on each requests.- Default value: 1 - Type: integer - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.servicewatch.wmi.mui

The MID Server supports MUI (Multilingual UI) configuration.

  • Default value: false
  • Type: true/false
  • Location: This property is available under specific MID Server parameters as described in Add a MID Server parameter.
mid.powershell\_api.winrm.remote\_portSet the port used by WinRM to connect to remote hosts.- Default value: 5985 - Type: integer - Location: This property is available under specific MID Server parameters as described in Add a MID Server parameter.
mid.windows.management\_protocolThe management protocol the MID Server uses to connect to Windows servers. Allowed values are WMI and WinRM.- Default value: WMI - Type: string - Location: This property is available under specific MID Server parameters as described in Add a MID Server parameter.
mid.servicewatch.wmi.protocol

Communication protocol between the MID Server and the WMI collector. Allowed values: http/https.

  • Default value: http
  • Type: string
  • Location: This property is available under specific MID Server parameters as described in Add a MID Server parameter.
mid.use\_powershellAllows using PowerShell for executing commands on Windows servers.- Default value: false - Type: true/false - Location: This property is available under specific MID Server parameters as described in Add a MID Server parameter.
mid.sa.prefer\_powershell

Makes PowerShell the preferred method of executing commands on Windows servers.

Note: If you set this parameter to true, you must also set the mid.sa.use_powershell parameter to true.

  • Default value: false
  • Type: true/false
  • Location: MID Server > Properties
mid.win.baseboard.or.bios.insertion

Makes the Windows OS - Servers pattern discover the BIOS Serial Number instead of the Baseboard Serial Number.

  • Possible values: false - to populate the BaseBoard number; true - to populate the BIOS serial number.
  • Type: true/false
  • Default value: false
  • Location: MID Server > Properties
PropertyDescription
mid.snmp.request.timeoutThe time (in milliseconds) the MID Server waits for a response for each OID request.- Default value: 1500 - Type: Integer - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.snmp.portThe SNMP port.- Default value: 161 - Type: Integer - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.snmp.retryThe SNMP retry count.- Default value: 1 - Type: integer - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.snmp.table\_size\_limitMaximum table size to bring in the SNMP table requests.- Default value: 20000 - Type: integer - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.snmp.table\_walk\_limitMaximum requests in the SNMP walk session.- Default value: 10000 - Type: integer - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.snmp.get\_table\_timeout\_secMaximum time (in seconds) allowed for load of a whole SNMP table.- Default value: 600 - Type: integer - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.snmp.walk\_timeout\_secMaximum time (in seconds) allowed for the SNMP walk session.- Default value: 600 - Type: integer - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.snmp.discover\_engineDiscovery authoritative engine ID on SNMP V3 sessions.- Default value: true - Type: true/false - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.snmp.snmp\_v2\_disabledDisable usage of SNMP version 2- Default value: false - Type: true/false - Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.
mid.sa.snmp.failed\_status\_oid

OID indicating the Failed status. If an SNMP result starts with this OID, the MID Server considers it a failure.

  • Default value: 1.3.6.1.6.3.15.1.1.3
  • Type: string
  • Location: This property is not available in the base system. You can add the property as described in Create a MID Server property.

Parent Topic:Service Mapping reference