Skip to main content

Installing and configuring the MID Server on Linux

The Management, Instrumentation, and Discovery (MID) Server is a Java server that facilitates communication and movement of data between the ServiceNow platform and external applications, data sources, and services.

Before you begin

Ensure that the minimum requirements are met for the MID Server (see MID Server system requirements from the ServiceNow online documentation).

The MID Server connects to a ServiceNow instance by using the SOAP web service. To allow authentication with the ServiceNow instance, create a separate user account for each MID Server or share the same account across multiple MID Servers. Each MID Server account must use the mid_server role to access protected tables.

Procedure

To install the MID server, setup a MID Server user and role in ServiceNow, and then download and install the MID server files.

  1. Set up the MID Server user account on the ServiceNow instance.
    1. om the ServiceNow portal, click User Administration > Users.
    2. Locate the mid.user user account in the User ID column.
    3. Verify that the following fields are filled. Update the password, if required.

      • User ID. User ID that is to be specified in the mid.instance.username parameter of config.xml.

      • Password. Password that is to be specified in the mid.instance.password parameter of config.xml.

      • First name. User's first name

      • Last name. User's last name

      Note

      • Change the default password as soon as possible.

      • Avoid updating the fields other than Password. For information about the password for default user accounts, see Creating a ServiceNow REST user.

    4. Click Update.
  2. Download and install the MID server files. For more information, see Install a MID Server on Linux from the ServiceNow online documentation.
    1. om the ServiceNow portal, click Mid Server > Downloads.
    2. Click the Copy link icon for the appropriate operating system to copy the file link, and then use the wget <copied_link> command to download the MID Server. For example
      wget https://install.service-now.com/glide/distribution/builds/package/app-signed/mid-linux-installer/
      2022/01/04/mid-nux-installer.rome-06-23-2021_patch5-12-15-2021_01-04-2022_2221.linux.x86-64.rpm
    3. Run the following command to install the MID server file.

      • RedHat Enterprise Linux. sudo rpm -ivh –nodeps <package_name>.rpm –previx=/<path_to_user_directory>

      • Ubundu. sudo dpkg -i <package_name>.deb

    4. Run the ./installer.sh command from the agent/bin directory as root and provide the required input to configure the MID Server service.

      • ServiceNow Instance URL. Enter the full URL of your ServiceNow instance, for example: https://mycompanyinstance.service-now.com

      • MID-Server Username. Enter the user name of the MID Server user that you already created. The MID Server user must have the mid_server role.

      • MID-Server Password. Set the password for the current MID Server user.

      • MID-Server Name. Set the name of the MID Server.

  3. Validate the MID server. For more information, see Validate the MID Server from the ServiceNow online documentation.
    1. From the ServiceNow portal, click MID Server > Servers.
    2. Open the new MID Server you created from the list of MID Servers.
    3. Under Related Links, click Validate to display the Set Initial Selection Criteria dialog.
    4. Use the toggles to enable or disable criteria for the MID Server.

      • Allow ALL capabilities: Allow all orchestration and event management functions.

      • Allow ALL applications: Allow all applications that use MID Servers to use this MID Server.

      • Allow ALL IP ranges: Make all IP ranges valid for this MID Server, meaning that it can target any IP address.

    5. Click OK to start the validation process.

What to do next

The MID Server runs as a standalone service. It can be removed easily to accommodate such tasks as redeploying the MID Server to another host system or changing the unique name of a MID Server when deploying multiple MID Servers.

To remove the service and uninstall a MID Server on Linux, run the uninstall.sh script in the agent directory. For more information, see Install a MID Server on Linux from the ServiceNow online documentation