MID Server properties used by Service Mapping

  • Release version: Xanadu
  • Updated August 1, 2024
  • 12 minutes to read

    • 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

    Property Description
    mid.file_tracking.file_path_forbidden_strings Comma-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.

    SSH-related properties

    Property Description
    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_regex A 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_cols The 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_rows The 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_prompt The 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_timeout The 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_response The 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_chars The 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_regex When 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_command An 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_regex SSH 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_regex A 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_regex A 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.timeout The 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.retry The 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_su A 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_char A 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_threads Same 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.

    WMI-related properties

    Important:
    WMI Collector is deprecated in New York patch 10 and later. See the KB0791835 WMI Collector deprecation detailsfor more information.
    Properties Description
    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.port The 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.timeout The 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_response The 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_regex The 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_count The 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_port Set 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_protocol The 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_powershell Allows 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

    SNMP-related properties

    Property Description
    mid.snmp.request.timeout The 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.port The 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.retry The 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_limit Maximum 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_limit Maximum 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_sec Maximum 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_sec Maximum 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_engine Discovery 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_disabled Disable 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.