MID Server parameters

These parameters are available for MID Servers.

Required parameters

Note: Using special characters in an XML configuration file requires you to encode them.
Label Names Description
Instance URL url Specifies the URL to the associated ServiceNow instance. Normally the URL is similar to https://instance.service-now.com, where you replace instance with the instance name. If you host your own ServiceNow instance, use the URL set by your organization.
  • Type: string
  • Default value: none
MID Server ID mid_sys_id Records the MID Server record's unique identifier. This parameter should be empty when you initially configure a MID Server . Do not change the value.
  • Type: string
  • Default value: automatically set (GUID)
MID Server name name Use this parameter to supply a name that is meaningful for you. If you do not supply this parameter, the MID Server uses the default value. A set of business rules synchronizes the name in the configuration file with the name in the MID Server record. The business rules ensure that changing the name in one location also changes the name in the other location.
  • Type: string
  • Default value: YOUR_MIDSERVER_NAME_GOES_HERE
Instance user name mid.instance.username or glide.glidesoap.username If the ServiceNow instance has authentication enabled, as it is by default, set this parameter to define the user name the MID Server should use to log in to the instance. This user should have the mid_server role on the ServiceNow instance in order to access necessary tables and fields.
  • Type: string
  • Default value: none
Instance password mid.instance.password or glide.glidesoap.password If your ServiceNow instance has authentication enabled, as it is by default, set this parameter to define the password the MID Server should use to log in to the instance.
  • Type: string
  • Default value: none

CIM parameters

Label Names Description
Maximum number of messages sent at once to a CIM server. mid.cim.batch.size Specifies the maximum number of messages sent at once to a CIM server.
  • Type: integer
  • Default value: 1
Interval to wait between requests to the same CIMOM (ms). mid.cim.request.interval Specifies the number of milliseconds to wait between requests to the same Common Information Model Object Manager (CIMOM).
  • Type: integer (milliseconds)
  • Default value: 0
The maximum amount of simultaneous connections allowed per CIMOM. mid.cim.host.connection.limit Specifies the maximum number of simultaneous connections to each Common Information Model Object Manager (CIMOM). A value of zero disables simultaneous connections.
  • Type: integer (number of connections)
  • Default value: 0

Connection parameters

Label Names Description
Asynchronous Message Bus Client disable mid.disable_amb Disables the Asynchronous Message Bus (AMB) Client. When AMB is enabled, the MID Server uses a default polling interval of 40 seconds. When the AMB client is disabled, the default polling interval switches to 5 seconds. If you set a polling interval with the mid.poll.time parameter, the MID Server uses that value whether or not the AMB client is enabled.
  • Type: true | false
  • Default value: false
Instance date format instance.date.format Specifies the format the instance uses for dates and times. The primary impact of setting this parameter is to allow the MID Server to correctly refresh its start and stop times on the MID Server record in ServiceNow. The format of this date/time string is identical to that used by the Java SimpleDateFormat class.
  • Type: string (Date format)
  • Default value: yyyy-MM-dd HH:mm:ss
MID Server immediate response enable glide.mid.fast.responses Instructs the MID Server to try sending messages to the instance as soon as they are ready. Normally the MID Servers ends message to the ServiceNow instance serially (that is, one message at a time). Since many probes can be run in parallel, there can be multiple messages simultaneously transmitted to the instance. Setting this parameter to true may decrease the time between a probe's completion and its response arriving at the instance. However, the multiple simultaneous messages consume resources, decreasing the overall instance responsiveness. If there are communications problems, this parameter's value can also cause a logjam on the MID Server, as threads normally used for running probes may become consumed for sending messages. Generally, leave this parameter out of your configuration. Setting it to true is meaningful only under very special circumstances.
  • Type: true | false
  • Default value: false
MID Server JMX enable mid.jmx.enabled Enables a JMX server on the MID Server , which exposes some management information to JMX consoles. Implementing JMX requires additional configuration of the Java runtime environment. Setting this parameter to true is only recommended for those with detailed knowledge of the Java security architecture and a specific need for JMX.
  • Type: true | false
  • Default value: false
MID Server max transmission queue size glide.mid.max.sender.queue.size Places an upper limit on how large the queue is allowed to get. The MID Server starts deleting queued messages if this limit is exceeded. When the MID Server generates messages to the ServiceNow instance faster than it can send them, it queues them temporarily on the file system of the MID Server's host. This queue is normally quite small, and is completely emptied as soon as the MID Server processing slows for a short period. However, this queue can grow in size when there are communication problems between the MID Server and the instance, and especially if there is an integration running on the MID Server , .
The parameter is of the form {number}{multiplier}, where {number} is any positive decimal number including non-integers, and the optional multiplier is any spelling of bytes, kilobytes, megabytes, gigabytes, or terabytes (only the first character is tested, and the test is case-insensitive). The default multiplier is bytes. White space is liberally tolerated. The following strings all represent valid parameters: "1000000000", "0.5m", "5 GB", "7.67gigas", "145.69392 meg", and "1.1 terra".
  • Type: string
  • Default value: 0.5 GB
MID Server maximum number of probe threads threads.max Controls the number of execution threads (simultaneous work) that probes may use. This parameter provides direct control over what CPU resources the MID Server consumes on the computer that hosts it. To decrease the MID Server 's CPU consumption, lower the number of threads. To make the MID Server work faster, increase the number of threads. See Set MID Server Thread Use.
  • Type: integer (threads)
  • Default value: 25
Maximum amount of interactive messages to queue in memory for processing. threads.interactive.max Sets the maximum amount of interactive messages to queue in memory for processing.
  • Type: integer (threads)
  • Default value: 4
Maximum amount of expedited messages to queue in memory for processing. threads.expedited.max Sets the maximum amount of expedited messages to queue in memory for processing.
  • Type: integer (threads)
  • Default value: 4 (threads)
MID Server poll time in seconds when MID server is not busy. mid.poll.time Sets the default MID Server polling interval (in seconds). The polling interval is the amount of time the MID Server waits before checking the ECC queue for work when the ECC queue is not busy. The MID Server polls the ECC queue using this interval if the AMB client connection is dropped.
Note: The default polling interval resets to 5 seconds when the AMB client is disabled. If you configure the mid.poll.time parameter, the MID Server uses this polling interval whether or not the AMB client is connected.
  • Type: integer (seconds)
  • Default value: 40

Credentials parameters

Label Names Description
Credentials provider. mid.credentials.provider Specifies the Java class name of the credentials provider.
  • Type: string
  • Default value: com.service_now.mid.creds.standard.StandardCredentialsProvider
Class that the MID server uses to generate secure key pairs. mid.secure_credentials.key_pairs.provider Class that the MID server uses to generate secure key pairs.
  • Type: String
  • Default value: com.service_now.mid.keypairs.provider.standard.StandardKeyPairsProvider

Debug parameters

Table 1. MID Server debug parameters
Label Names Description
Debug logging enable. debug.logging

[Deprecated] Specifies whether to enable logging of MID Server events and messages (both sent and received). Normally this parameter is only used by developers, but it is occasionally useful when troubleshooting a problem. Be aware that setting this parameter to true causes intensive logging on the MID Server , potentially using considerable disk space.

  • Type: True | False
  • Default value: false

This parameter has been replaced by the mid.log.level parameter.

Debug mode enable. debug

[Deprecated] Specifies whether to enable debug logging on the MID Server . Normally this parameter is only used by developers, but it is occasionally useful when troubleshooting a problem. Be aware that setting this parameter to true causes intensive logging on the MID Server , potentially using considerable disk space.

  • Type: True | False
  • Default value: false

This parameter has been replaced by the mid.log.level parameter.

Debug file probe templates. file.probe.template.debug Specifies whether to debug file probe templates.
  • Type: True | False
  • Default: false
Enables debug logging for CIM / WBEM / SLP / SMI-S. mid.cim.debug Specifies whether to enable debug logging for CIM, WBEM, SLP, or SMI-S.
  • Type: True | False
  • Default value: false
Enable debug logging for ServiceNow SSH Client. mid.ssh.debug Enables SSH debug information in the log file. The parameter usage depends on whether the ServiceNow SSH client is enabled.
When the ServiceNow SSH client is enabled, the 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>: Specify 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.
    • deferred: Logs 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.
When the ServiceNow SSH client is disabled, the parameter enables or disables SSH debug information in the log file:
  • Type: True | False
  • Default value: false
MID Server logging level. mid.log.level Specifies the logging level for the MID Server. Possible values are:
  • debug
  • info
  • warn
  • error
Note: Values are case insensitive.
  • Type: String
  • Default value: info
Enables debug logging for the Idle Connection Monitor. mid.http.idle_connection_monitor.debug Enables debug logging for the Idle Connection Monitor.
  • Type: True | False
  • Default value: false

DNS parameters

Label Names Description
DNS scanning regulator interval (ms) mid.dns_scan.regulator.internval_ms Specifies the interval between DNS scans in milliseconds.
  • Type: Integer
  • Default value: 10
DNS scanning regulator packets per interval mid.dns_scan.regulator.packets_per_interval Specifies the number of regulator packets per DNS scan.
  • Type: Integer
  • Default value: 1
DNS scanning default name servers mid.dns_scan.default_name_servers Specifies the host names or IP addresses of the default name servers.
  • Type: String
  • Default value: none
DNS scanning additional name servers mid.dns_scan.additional_name_servers Specifies the host names or IP addresses of any additional name servers.
  • Type: String
  • Default value: none
DNS scanning load balancing enable mid.dns_scan.load_balancing_enable Specifies whether to enable load balancing of name servers.
  • Type: True | False
  • Default value: false

FTP connection parameters

Label Name Description
Max size of the FTP Connection Pool mid.ftp.max_pool_size Specifies the maximum size of the FTP Connection Pool, in megabytes.
  • Type: Integer
  • Default value: 25
Max number of the FTP connections per target mid.ftp.max_per_target Specifies the maximum number of the FTP connections per target.
  • Type: Integer
  • Default value: 5
Max amount of time that an FTP connection can sit idle in the pool mid.ftp.max_conn_idle_time Specifies the maximum amount of time, in milliseconds, that an FTP connection can sit idle in the pool.
  • Type: Integer
  • Default value: 300000
Max number of files that can be returned in the filesystem list directory command mid.filesystem.max.ls Specifies the maximum number of files that can be returned in the filesystem list directory command.
  • Type: Integer
  • Default value: 10000

Logging parameters

Label Names Description
Disable monitor checking disable_monitors Specifies whether to disable the MID Server from actively checking for monitors on the instance.
  • Type: True | False
  • Default value: false
Query logging enable mid.show.queries Instructs the MID Server whether to log details about every query it makes to the ServiceNow instance. Typically this parameter is only used by developers, but it is occasionally useful when troubleshooting a problem. Be aware that setting this parameter to true causes intensive logging on the MID Server, potentially using considerable disk space.
  • Type: True | False
  • Default value: false
Remote logging disable disable.remote.logging Prevents the MID Server from logging any information to the MID Server log on the instance. Relatively little information is logged on the instance in any case, but setting this parameter to true eliminates all logging to the instance.
  • Type: True | False
  • Default value: false
Status sending disable disable.status Prevents the MID Server from sending a status report to the instance every 10 minutes.
  • Type: True | False
  • Default value: false

Proxy server parameters

Label Names Description
Instance proxy enable mid.instance.use_proxy or mid.proxy.use_proxy If your MID Server must go through a web proxy to access the ServiceNow instance, set this parameter to true to instruct the MID Server to use the proxy. You must also set the proxy server's host and port, and perhaps the user name and password as well.
  • Type: True | False
  • Default value: false
Instance proxy host mid.proxy.host If your MID Server must go through a web proxy to access the ServiceNow instance, set this parameter to define the proxy's host.
  • Type: String
  • Default value: none
Instance proxy password mid.proxy.password If your MID Server must go through a web proxy to access the ServiceNow instance, and your proxy requires a password, set this parameter to define that password.
  • Type: String
  • Default value: none
Instance proxy port mid.proxy.port If your MID Server must go through a web proxy to access the ServiceNow instance, set this parameter to define the proxy's port.
  • Type: Integer (0-65535)
  • Default value: 80
Instance proxy user name mid.proxy.username If the MID Server must go through a web proxy to access the ServiceNow instance, and the proxy requires a user name, set this parameter to define that user name.
  • Type: String
  • Default value: none

Shazzam parameters

Label Names Description
Port probe packet interval mid.shazzam.regulator.interval_ms Sets the interval, in milliseconds, in which Shazzam can launch packets. This parameter works with the mid.shazzam.regulator.packets_per_interval parameter to set the number of packets allowed in this interval. By default, Shazzam launches one packet each millisecond.
  • Type: Integer
  • Default value: 1
Port probe packets launched per regulator interval mid.shazzam.regulator.packets_per_interval Sets the number of packets that Shazzam can launch in the configured time interval. This parameter works with the mid.shazzam.regulator.interval_ms parameter, which sets that interval. By default, Shazzam launches one packet each millisecond.
  • Type: Integer
  • Default value: 1
Shazzam chunk size mid.shazzam.chunk_size Specifies the maximum number of IP addresses that Shazzam scans in parallel. This parameter primarily controls outbound port consumption.
  • Type: Integer
  • Default value: 100

SSH Discovery parameters

Label Names Description
MID Server connection cache mid.connection_cache Specifies whether to cache connections. Set to false to disable connection caching. This parameter applies to SSH connections only.
  • Type: true | false
  • Default value: true
Decide if the PATH environment variable should be set for SSH commands mid.ssh.set_path Specifies whether to set the PATH environment variable for SSH commands.
  • Type: true | false
  • Default value: true
Process commands against localhost via SSH rather than console mid.ssh.local Specifies whether to execute commands for the MID Server host machine (localhost) via SSH rather than from a console. This allows long-running commands to execute properly. This parameter applies to the legacy SSH client only.
  • Type: true | false
  • Default value: false
MID Server SSH connection per host mid.ssh_connections_per_host Controls the number of concurrent probes the MID Server can run against a given host. Lowering the number of concurrent connections can slow Discovery.
  • Type: integer
  • Default value:
    • 7 for the ServiceNow client
    • 3 for the legacy SSH client
Enable (or disable) sudo to preserve environment (-E) for SSH mid.ssh.sudo_preserve_environment Specifies whether to use sudo to preserve the environment for SSH.
  • Type: true | false
  • Default value: false
Set the PATH environment paths for SSH commands mid.ssh.path_override Overrides the default paths set before executing a command. Enter 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.
  • Type: string (a colon-separated list of directories)
  • Default value: None
Enable the ServiceNow SSH Client mid.ssh.use_snc Enables the ServiceNow SSH client (SNCSSH) on individual MID Servers. SNCSSH is a ServiceNow implementation of an SSH client and is active by default for all MID Servers on new instances, via a MID Server property. Enabling the ServiceNow SSH client disables the legacy J2SSH client.
Important: Mixing SSH client types for MID Servers connected to the same instance is not a good practice.
  • Type: true | false
  • Default value: false
The maximum number of times to retry an SSH operation after a timeout mid.ssh.max_retries Specifies the maximum amount of times to retry an SSH operation after a time-out. The system sleeps two seconds between each connection attempt. By default, the MID Server retries once only. Set the parameter to 0 to disable retries.
  • Type: integer
  • Default value: 1
Sets a different remove file command to replace the default '/bin/rm -f' mid.ssh.alt_rm Sets a different SSH remove file command.
  • Type: string
  • Default value: none
Delay sending any SSH commands to a server after connecting mid.ssh.initial_delay_ms Delays sending any SSH probe commands to a server after connecting to the target for the time specified, in milliseconds. This parameter applies to the legacy SSH client only.
  • Type: integer (milliseconds)
  • Default value: 0
Suppress history file generation for SSH mid.ssh.suppress_history Suppresses the generation of the SSH history file. This parameter applies to the legacy SSH client only.
  • Type: true | false
  • Default value: false
Timeout in ms for SSH socket read mid.ssh.socket_timeout Specifies the timeout value for the SSH socket to prevent issues created by a socket timeout. Some devices, such as systems with embedded controllers like UPSs and PDUs, that have SSH enabled require more time to respond to an authentication request. The default value of 2 minutes ensures such requests do not timeout prematurely.
  • Type: integer (milliseconds)
  • Default value: 120000 (2 minutes)
Timeout in ms for SSH channel activity mid.ssh.channel_timeout Specifies the amount of time that the MID Server waits for activity on the SSH socket before closing the connection. If there has been no activity on the SSH socket for the specified timeout value, the MID Server closes the connection. Some devices, such as systems with embedded controllers like UPSs and PDUs, that have SSH enabled may require more time to respond to an authentication request.
  • Type: integer (milliseconds)
  • Default value: 120000 (2 minutes)
Timeout in ms for SSH socket read mid.ssh.session_timeout Specifies the amount of time that a cached session remains in memory after last use. Excessively small values tend to decrease performance. This parameter applies to the ServiceNow SSH client only.
  • Type: integer (milliseconds)
  • Default value: 300000 (5 minutes)
Timeout for SSH command execution (ms) mid.ssh.command_timeout_ms The timeout duration, in milliseconds, for the execution of an SSH command.
  • Type: integer (milliseconds)
  • Default value: 300000 (5 minutes)
Use keyboard interactive authentication for SSH mid.ssh.use_keyboard_interactive Uses the keyboard interactive authentication mode in SSH daemons on which it is activated.
  • Type: true | false
  • Default value: false
Min size of DH group in bits mid.ssh.dh_group_length_min Specifies the minimum group length in bits used for generating a "shared secret" key in Diffie-Hillman key exchange. The larger the key the more secure the SSH connection is but at the cost of performance.
  • Type: integer (bits)
  • Default value: 1024
Max size of DH group in bits mid.ssh.dh_group_length_max Specifies the maximum group length in bits used for generating a "shared secret" key in Diffie-Hillman key exchange. The larger the key the more secure the SSH connection is but at the cost of performance.
  • Type: integer (bits)
  • Default value: 2048
List of bourne-compatible shells mid.ssh.shells_supported Defines the bourne-compatible shells supported by the MID Server. This value is a comma-separated list of supported shells, such as ksh, dsh, bash and sh.
  • Type: string
  • Default value: ksh,bash,sh
Discard long running command error output, emulating legacy behavior. mid.ssh.discard_lrc_error Discard long running command error output, emulating legacy behavior.
  • Type: String
  • Default value: j2ssh - true, sncssh - false
Ratio of ssh session pool capacity to mid thread number in percentage. mid.ssh.pool_thread_ratio The ratio of SSH session pool capacity to the MID Server thread number, in percentage. The pool capacity is at least 25%.
  • Type: Integer
  • Default value: 75
Disable the privilege check for SSHCommand. mid.ssh.disable_privilege_check When this parameter is set to true, the Mid Server assumes that the user configured in the credential has the privilege to run the given command. For example, if you configure a Mid Server to use sudo, the Mid Server will assume that discovery user can run any command with “sudo”. The Mid Server still validates that sudo commands can be run on the target.
  • Type: true | false
  • Default value: false
By default, the MID Server is configured to search for SSH commands in the following paths and the logged-on user's default paths:
  • /usr/sbin
  • /usr/bin
  • /bin
  • /sbin

Upgrade parameters

Label Names Description
Fixed MID Server version mid.pinned.version Name of the version to which this MID Server is pinned.
  • Type: string
  • Default value: build timestamp
Upgrade proxy enable mid.upgrade.use_proxy If your MID Server must go through a web proxy to access the upgrade URL, set this parameter to true to instruct the MID Server to use the proxy. You must also set the proxy server's host and port. If the instance proxy user name and password are set, they are used for the upgrade proxy as well.
  • Type: true | false
  • Default value: false
Upgrade proxy host glide.mid.autoupgrade.proxy_host or glide.glidesoap.proxy_host If your MID Server must go through a web proxy to access the upgrade URL, define the proxy's host here.
  • Type: string (URL)
  • Default value: none
Upgrade proxy port glide.mid.autoupgrade.proxy_port or glide.glidesoap.proxy_port If your MID Server must go through a web proxy to access the upgrade URL, define the proxy's port here.
  • Type: integer (0-65535)
  • Default value: 80
Upgrade proxy user glide.mid.autoupgrade.proxy_user If your MID Server must go through a web proxy to access the upgrade URL, define the proxy's user name here.
  • Type: string (URL)
  • Default value: none
Upgrade proxy password glide.mid.autoupgrade.proxy_password If your MID Server must go through a web proxy to access the upgrade URL, define the proxy's password here.
  • Type: string
  • Default value: none

Windows Discovery parameters

Label Names Description
Enable or disable Powershell parameter passing via the command line. mid.powershell.command.parameter_passing Enable this parameter to allow passing Powershell parameters from the command line.
  • Type: True | False
  • Default value: false
Enable or disable the Powershell script parameter passing via the command line. mid.powershell.command.script.parameter_passing Enable this parameter to allow passing Powershell scripts from the command line.
  • Type: True | False
  • Default value: true
Enable or disable the enforcement of UTF-8 for command output. mid.powershell.enforce_utf8 Enable this parameter to force commands on a target Windows system to return UTF-8 encoded output. Disabling it allows the target system to use its default encoding. This parameter is only valid when PowerShell is enabled.
Setting this value to false may result in incorrect values in the CMDB when non-ASCII characters are returned by a probe.
  • Type: True | False
  • Default value: true
Enable PowerShell for Discovery. mid.use_powershell Specifies whether to enable PowerShell for Discovery. The MID Server requires PowerShell version 2 to operate. If the MID Server cannot find the correct version of PowerShell, it uses WMIRunner instead.
  • Type: True | False
  • Default value: false
Enable/Disable automatically falling back to the MID Server service user credential if all other credentials fail. mid.powershell.local_mid_service_credential_fallback Specifies the login credentials the MID Server uses if all other credentials fail.
  • Type: True | False
  • Default value: false
Timeout for Windows probes. mid.windows.probe_timeout Specifies the timeout value for the Windows probe, in seconds. The default value is 5 minutes.
  • Type: Integer
  • Default value: 600 seconds
Powershell use credentials table. mid.powershell.use_credentials Specifies whether PowerShell Discovery should use the Windows credentials from the credentials table. To use PowerShell Discovery on a single domain, set this parameter to false, and then restart the MID Server . In this case, the MID Server runs the probes with the credentials of the user for the MID Server process.
  • Type: True | False
  • Default value: true
Path to Powershell executable. mid.powershell.path

Enables an administrator to point to a specific PowerShell on a MID Server in cases where more than one PowerShell is installed. Supply the path to the directory containing the PowerShell executable, for example, C:\mypowershell or C:\mypowershell\. ServiceNow automatically appends the string powershell.exe to the path.

This parameter might be necessary when both 32-bit and 64-bit PowerShells are active on the same MID Server , and it becomes necessary to launch the correct PowerShell for the context. Note that 64-bit Windows employs file system redirection and the MID Server runs as a 32-bit application. If the path is in %WinDir%\System32, Windows automatically redirects to %WinDir%\SysWOW64. To avoid redirection, specify the path as %WinDir%\Sysnative. An example would be to specify C:\WINDOWS\sysnative\WindowsPowerShell\v1.0\ instead of C:\WINDOWS\system32\WindowsPowerShell\v1.0\.
Note: On a 64-bit version of Windows Server 2003 or Windows XP, a Microsoft hotfix may be required to enable this capability.
  • Type: String (path)
  • Default value: none
Set the protocol MID Servers use to communicate with remote Windows hosts. mid.windows.management_protocol
Enables administrators to select the Windows management protocol used for device and process classification. Options include:
  • WMI
  • WinRM
  • Type: String
  • Default value: WMI
Set the port WinRM will use to connect to remote hosts. mid.powershell_api.winrm.remote_port Specifies the communications port the MID Server uses to communicate with Windows Remote Management (WinRM) protocol.
  • Type: Integer
  • Default value: 5985
Maximum number of sessions allowed in the pool per target. mid.powershell_api.session_pool.target.max_size

Specifies the maximum number of sessions allowed in the pool per target host.

Note: Setting or changing this parameter requires restarting the MID Server.
  • Type: Integer
  • Default value: 2
Maximum number of sessions allowed in the session pool. mid.powershell_api.session_pool.max_size

Specifies the maximum number of sessions allowed in the session pool.

Note: Setting or changing this parameter requires restarting the MID Server.
  • Type: Integer
  • Default value: 25
Idle Powershell session timeout (seconds). mid.powershell_api.idle_session_timeout

Specifies the timeout value of idle Powershell sessions in seconds.

Note: Setting or changing this parameter requires restarting the MID Server.
  • Type: Integer
  • Default value: 60
Timeout for all Windows probes on a MID Server. mid.windows.probe_timeout Sets the timeout interval for all Windows probes on a specific MID Server . This value is overridden by the values configured for individual probes with the wmi_timeout probe parameter.
  • Type: Integer
  • Default value: 300

SNMP configuration parameters

Label Names Description
Enable automatic inclusion of SNMP public community string. mid.snmp.enable_auto_public Specifies whether to use the SNMP public community string automatically if no other SNMP credentials were successful.
  • Type: True | False
  • Default value: true
Maximum time to wait for a response for the first OID request. mid.snmp.request.timeout Specifies the timeout value for the first OID request, in milliseconds. For subsequent requests (for example, table OIDs), the mid.snmp.session.timeout configuration parameter (see below) takes effect.
Note: You can override this parameter with the timeout SNMP probe parameter.
  • Type: Integer
  • Default value: 1500
Maximum time to wait for responses to OID requests once a session has been established. mid.snmp.session.timeout Specifies the timeout value for subsequent OID request, in milliseconds. SNMP communication is stateless and does not have a session or connection in the normal sense. The system regards a positive response from the first OID request as a sign that it should expect prompt responses to subsequent requests. While the default is short, it may be useful to increase this parameter value to the same value as that used for mid.snmp.request.timeout.
Note: You can override this parameter with the establish_session_timeout SNMP probe parameter.
  • Type: Integer
  • Default value: 500
Use the Snmp4j library for SNMP communication. mid.snmp.use_snmp4j Use the Snmp4j library for SNMP communication. This is a strict requirement for SNMPv3. This parameter should only be set to false based on advice from customer support.
  • Type: True | False
  • Default value: true
Use SNMP v1 and v2c for probes. mid.snmp.use_snmp_v1_v2c Attempt communication using these SNMP protocol versions. Requires configuration of SNMP community string credentials or the mid.snmp.enable_auto_public parameter set to true, as applicable for targeted devices.
  • Type: True | False
  • Default value: true
Use SNMP v3 for probes. mid.snmp.use_snmp_v3 Attempt communication using the SNMPv3 protocol version. Requires configuration of SNMPv3 credentials.
  • Type: True | False
  • Default value: true
Table 2. Event Management parameters
Label Name Description
Bulk size for sending events mid.probe.event.bulk_size Specifies the maximum size of an event payload, in MB.
  • Type: Integer
  • Default value: 120
Waiting period on empty queue for sending events mid.probe.event.wait_time Waiting period on an empty queue for sending events.
  • Type: Integer
  • Default value: 1000
Enables or disables sending events. mid.probe.event.send.enabled Enables or disables the sending of events.
  • Type: True | False
  • Default value: true
Maximum size of events queue allowed before events will be rejected mid.probe.event.queue.max_size Specifies the maximum size permitted for the event queue before incoming events are rejected.
  • Type: Integer
  • Default value: 100,000
If true then bulk of events will be sent to the server instead of single event sending mid.probe.event.queue.use_bulk Specifies whether events are sent to the server singly or in bulk. If this parameter evaluates to true then events are sent to the server in bulk.
  • Type: True | False
  • Default value: true
Limit of number of active metrics to CI mappings mid.em.metric.metric_to_ci_map_limit Specifies the maximum number of active metrics allowed per CI map.
  • Type:
  • Default value: 200,000
Number of seconds to wait before resending unhandled event mid.em.metric_binding_timeout_seconds Specifies the number of seconds to wait before resending unhandled events
  • Type: Integer
  • Default value: 300
Max number of seconds to wait before resending unhandled event mid.em.metric_binding_timeout_max_seconds Specifies the maximum number of seconds to wait before resending unhandled events.
  • Type: Integer
  • Default value: 10800
Max number of seconds before refreshing the metric source type cache in memory mid.em.metric_max_elapsed_time_before_refresh Specifies the maximum number of seconds before the metric source type cache is refreshed in memory.
  • Type: Integer
  • Default value: 60
Max length of string used for SQL command mid.em.matric_max_sql_string_length_for_types Specifies the maximum length of the string (composed of types) used for an SQL command
  • Type: Integer
  • Default value: 30000
Period, in seconds, between statistics reports to the instance. mid.em.statistics_report_perioon_sec Specifies the period, in seconds, between statistics reports to the instance. Use 0 to disable reporting. This parameter requires a restart.
  • Type: Integer
  • Default value: 60
Max number of seconds to collect metrics in every cycle mid.em.metric_connector_max_run_time_seconds Specifies the maximum number of seconds to collect metrics in every cycle.
  • Type: Integer
  • Default value: 300
Number of minutes to go back in history to retrieve metrics mid.em.metric_connector_history_min Specifies the number of minutes to go back in history to retrieve metrics.
  • Type: Integer
  • Default value: 180
Metric/Event Log Level mid.em.metric_event_logging Specifies the level of metric and event logging. Choices are:
  • none
  • all
  • events
  • metrics
  • metrics:<filter>
  • events:<filter>
  • Type: String
  • Default value: none
Number of seconds of delay when collecting metrics mid.em.metric_connector_late_arrivals_delay Specifies the number of seconds to delay when collecting metrics.
  • Type: Integer
  • Default value: 30