MID Server parameters for PowerShell

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 3 minutes to read

    • Parameters control the behavior of a particular MID Server and have lower precedence than MID Server properties.

    The following parameters are optional.
    Note:
    After changing the setting for any parameter, be sure to restart the MID Server service.
    Name Description
    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
    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: 3
    mid.powershell_api.winrm.use_ssl Requires the use of SSL certificates for HTTPS connections using WinRM.
    • Type: True | False
    • Default value: false
    mid.powershell_api.winrm.additional_pssesion_options Controls advanced options for a PSSession. For more information about advanced PSSession options, see https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/new-pssessionoption?view=powershell-6.
    mid.powershell_api.winrm.remote_https_port Configures the port for connecting to Windows servers using PowerShell over HTTPS.
    • Type: Integer
    • Default value: 5986
    mid.powershell_api.winrm.remote_port Configures the port for connecting to Windows servers using PowerShell over HTTP.
    • Type: Integer
    • Default value: 5985
    mid.powershell_api.winrm.skip_ssl_cert_check Skips the SSL certificate check when using WinRM for HTTPS connections.
    • Type: True | False
    • Default value: false
    mid.powershell_api.winrm.skip_ssl_cert_check_options
    Skips specific SSL certificate checks when using WinRM for HTTPS connections. Configure the MID Server to skip checks for certificates from a Certification Authority (CA), from the Common Name (CN) that identifies the host associated with the certificate, and for revoked certificates.
    • Type: String
    • Default value: -SkipCACheck -SkipCNCheck -SkipRevocationCheck
    mid.powershell.use_credentials
    Determines the credentials to use for Discovery with PowerShell. A setting of true directs the MID Server to run probes with the Windows credentials from the credentials table. To run probes with the credentials of the user for the MID Server service, set this parameter to false.
    • Type: true | false
    • Default value: true
    mid.use_powershell
    Enables or disables PowerShell for Discovery. Restart the MID Server after changing the value. If PowerShell is not installed or the version installed is less than version 2.0, Discovery reverts to using WMIRunner.
    • Type: true | false
    • Default value: true
    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 folder containing the PowerShell executable, for example, C:\mypowershell or C:\mypowershell\. ServiceNow automatically appends the string powershell.exe to the path. Configure this parameter when both a 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. 64-bit Windows employs file system redirection and the MID Server runs as a 32-bit application. If trying to specify a path in %WinDir%\System32, Windows automatically redirects to %WinDir%\SysWOW64. To avoid redirection, specify the path as %WinDir%\Sysnative. For example, instead of C:\WINDOWS\system32\WindowsPowerShell\v1.0\, specify C:\WINDOWS\sysnative\WindowsPowerShell\v1.0\.

    Note:
    On a 64-bit version of Windows XP, a Microsoft hotfix may be required to enable this.

    To discover applications running on a 64-bit Windows machine, the MID Server must be running on a 64-bit Windows host machine.

    • Type: string (path)
    • Default value: none
    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
    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
    mid.powershell.command.parameter_passing Enable this parameter to allow passing PowerShell parameters from the command line.
    • Type: True | False
    • Default value: false
    mid.powershell.command.script.parameter_passing Enable this parameter to allow passing PowerShell scripts from the command line.
    • Type: True | False
    • Default value: false
    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
    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: 600