Installing and configuring the Nutanix Calm plugin for ServiceNow

Installing and configuring the Nutanix Calm plugin for ServiceNow

Today’s article is a guest post by Yannick Struyf, Nutanix Senior Systems Engineer based in Antwerp, Belgium. As you’ll see below, Yannick has taken a huge amount of time to put together a heavily curated and detailed description of how to install the configure the Nutanix Calm plugin for ServiceNow. This is really exciting content and will definitely appeal to a large number of Nutanix and ServiceNow customers alike. Thanks Yannick! ūüôā

Nutanix Calm is the self-service portal product of Nutanix. With Nutanix Calm it is possible for enterprises to automate infrastructure and application deployments. In this document we will show how to install and configure the Nutanix Calm plugin for ServiceNow. ServiceNow is a tool that is widely used by many enterprises. Integrating ServiceNow with Nutanix Calm offers end-users the possibility to create, manage and delete Nutanix Calm applications directly via the ServiceNow web interface.

General Overview

If you want to install the Nutanix Calm plugin for ServiceNow, you need to have admin access to a ServiceNow instance. If you don’t have a ServiceNow instance available, but you want to try the Nutanix Calm integration, it is possible to request a temporary developer instance via this link:¬†

Note: Version 1.2 of the plugin will be installed on a New York version of ServiceNow

Install and configure the Nutanix Calm plugin

ServiceNow is a product that runs in the cloud. A MID server needs to be installed in order to allow ServiceNow to communicate with Nutanix Calm. In this example I use a Windows 2016 server that is joined to an Active Directory domain. Below you can see a high-level overview of the solution.

alt text

Installing the mid server

  • To install the¬†MID¬†server, first login on your ServiceNow instance and search for the¬†MID¬†server section.
  • Go to Downloads and select the correct version of the installation files. In this case it is the¬†Windows 64 bit¬†variant.
  • Copy the installation file to your Windows 2016 server.
alt text
  • Create a directory on your Windows server and copy the installation files to the newly created folder.
  • Extract the zip file and run the¬†installer.bat¬†file in the¬†agent directory.
alt text
  • The¬†installer.bat¬†file will open an installation wizard.
  • Enter your ServiceNow instance URL and credentials.
  • Test your connection before proceeding clicking¬†next.
alt text
  • On the next screen give your¬†MID¬†server a name and press¬†next.
alt text
  • Press¬†next¬†after verifying the configuration.
alt text
  • Start your¬†MID¬†server and press¬†Exit.
alt text
  • If you want to double check if the service is running, open¬†services.msc¬†and make sure the¬†ServiceNow MID Server_<MID server name>¬†service is running.
alt text
  • When the service is running, go back to the ServiceNow web interface and go to the¬†Servers¬†board in the¬†MID¬†server section and check if the newly installed¬†MID¬†server is listed. You will see the server is not yet validated.
  • Click the checkbox next to your¬†MID¬†server entry and run the¬†validate¬†action.
alt text
  • Check if all fields in the pop-up box are enabled and press save. Now the¬†MID¬†server will be validated. This can take a few minutes to complete.
alt text
  • Do not proceed to the next steps before the¬†MID¬†server is validated.
alt text

Plugin Prerequisites

Additional pre-requisites must be checked before we can install the plugin.

Global Application Scope

  • Make sure you are in the global application scope. This can be verified by going to the¬†settings¬†in the right upper corner, go to the¬†Developer¬†tab and make sure the value for¬†Application¬†is set to¬†Global. Optionally you can enable¬†Show application picker in header. This will show the current application scope at the right upper corner of the ServiceNow web interface.
alt text

Table Permissions

  • Verify if all of the tables listed below have the required permissions.
sys_user_has_roleUser RoleRead, Create, Update
sys_user_grmemberGroup MemberRead, Create, Update
sys_group_has_roleGroup RoleRead, Create, Update
item_option_newVariableRead, Create, Update
sys_user_groupGroupRead, Create, Update
sc_categoryCategoryRead, Create, Update
sc_catalogCatalogRead, Create, Update
catalog_ui_policyCatalog UI PolicyRead, Create, Update
catalog_script_clientCatalog Client ScriptsRead, Create, Update
user_criteriaUser CriteriaRead, Create, Update
questionQuestionRead, Create, Update
question_choiceQuestion ChoiceRead, Create, Update

You can verify the permissions by checking the Tables dashboard in the System Definition section. You can use the filter at the top of the page to find the correct table.

alt text
  • Click on the correct table, go to¬†Application Access¬†and check the permissions.
  • When the permissions are correct, click¬†Update.
  • Repeat this procedure for all the tables.
alt text

Additional System Properties

  • Enter¬†sys_properties.LIST¬†in the search bar on the left of the ServiceNow web interface. This will open a different tab in your browser.
  • Search for the¬†¬†key and set the value to¬†true¬†and press¬†Update.
alt text
alt text
alt text

Install the User Criteria Scoped API Plugin

  • Go to the¬†Plugin¬†section, search for the plugin using ID¬†com.glideapp.user_criteria.scoped.api¬†and install it.
alt text

Installing and Configuring the Plugin

There are two methods of installing the Nutanix Calm ServiceNow plugin. The first method is a manual installation, the second one is via the ServiceNow Store. Both methods are shown in this document.

Installing v1.2 plugin via ServiceNow Store

  • On the ServiceNow web interface, enter¬†System Applications¬†in the filter field on the left side of the screen.
  • Click on the¬†All¬†section under the¬†All Available Applications¬†header and enter¬†Calm¬†in the search bar. The plugin will be ready for configuration after clicking¬†Install.
alt text
  • If the application is not found, login on the ServiceNow store and allow your ServiceNow instance to install the Calm plugin. Follow the steps in this video to add the application to your ServiceNow instance:

Contact your ServiceNow administrator if you do not have a login for the ServiceNow store.

Note: It is not allowed to install applications on ServiceNow developer instances using the ServiceNow Store. Please follow the manual procedure to install the Nutanix Calm ServiceNow plugin.

Installing v1.1 and v1.2 plugin manually

  • Download or git clone the files in the following git repo:¬†
  • You will see several folders in this repo. We will require both the v1.1 and v1.2 folder. Initially we will use the¬†Nutanix Full Certified Build(v1.0+v1.1).xml¬†file in the v1.1 folder.
  • Go to the¬†Retrieved Update Sets¬†section and upload the¬†Nutanix Full Certified Build(v1.0+v1.1).xml¬†file
alt text
alt text
  • When the file is uploaded, go into the¬†Nutanix Calm¬†update set.
alt text
  • Press¬†Preview Update Set¬†and wait until completion. If you get an error on this step, verify the pre-requisites earlier in this document.
alt text
  • Press¬†Commit Update Set¬†when the preview process completes.
alt text
  • Perform the same procedure for the¬†Nutanix Calm V1.2_5.xml¬†file in the v1.2 folder.

Below you can see the result of uploading the two XML files and performing a preview and a commit on both.

alt text

Configuring the Plugin

After completing the steps above, we can now configure the Nutanix Calm plugin.

  • In the search bar on the left, search for¬†calm.

Note: You can press the star icon next to the Nutanix Calm section to create a favorite.

  • It is important to change your application profile from¬†Global¬†to¬†Nutanix Calm¬†at this moment in time.
  • Go to¬†Application Properties¬†and fill in the required information:
    • Search for your¬†MID¬†server by pressing the search icon next to the input field
    • Press the lock icon next to the¬†Calm Instance¬†field and enter the URL to your Calm instance in following format:¬†https://<hostname>:<port>
    • Enter your Calm username and password
    • Configure your¬†Approval workflow. If you want to auto-approve, choose¬†Nutanix - Auto Approve¬†by pressing the search icon.
    • Configure the¬†Assignment Group. In this case I selected a random one.
  • When everything is entered, press¬†Save Properties¬†A connection and login attempt to your Calm instance will be performed.
  • If everything was successful, a¬†Sync Now¬†button will become visible. Click it before continuing.
alt text

The duration of the syncing process depends on the size of your Calm environment. The sync is complete when the Sync is in progress bar on the Application Properties section disappears.

You can now browse through your projects, blueprints and deployed applications via ServiceNow.

Create a Catalog Item

  • If you want to provision an application via ServiceNow, you first need to create a¬†Catalog item¬†for the blueprint.Go to¬†Catalog Items¬†and press¬†New.
alt text
  • Choose your project, blueprint and application profile for your catalog item.
alt text
  • On the¬†Choose Options¬†tab you can check all the input parameters defined on your blueprint.
alt text
  • On the¬†Checkout¬†tab you give a name and a description to your catalog item. When you are ready, press¬†Checkout.
alt text
  • The catalog item is now being created and can be requested after a few minutes. Go back to the¬†Catalog Items¬†section and check if the item is present.
alt text

Launch Catalog Item

  • To launch the catalog item, click on it and press¬†Launch.
alt text
  • Enter the mandatory information and press¬†Order Now.
alt text

This will trigger the required API calls via the MID server to your Calm instance. You can check the progress by checking the Orders section, or by opening the Calm UI.

alt text
alt text

When the order is complete, you can find it in the Applications section.

alt text

Performing Day-2 Operations

  • If you want to perform an action on a deployed application, go to¬†Applications, choose your application and scroll down.
  • Pick the correct action (in this case we will restart the Windows server), right(!) click and choose¬†Perform Action.
alt text

The action is now invoked.

alt text


This document demonstrated how to:

  • Install a MID server
  • Install and configure the Nutanix Calm ServiceNow plugin
  • Create a catalog item
  • Launch a catalog item
  • Perform a day-2 operation on a provisioned application

This document can also be found on the Nutanix Belux blog:

Wrapping Up

Huge thanks to Yannick Struyf for creating this great content! Thanks for reading a have a great day. ūüôā

Nutanix CALM DSL LAB 1.0


Have you wanted to learn the Nutanix Calm DSL, but haven't been sure where to start?
Check out the Nutanix Calm DSL Lab 1.0 now!