Set up Device Security and Cortex XSOAR for IBM Maximo Manage Integration
Focus
Focus
Device Security

Set up Device Security and Cortex XSOAR for IBM Maximo Manage Integration

Table of Contents

Set up Device Security and Cortex XSOAR for IBM Maximo Manage Integration

Set up Device Security and Cortex XSOAR to integrate with IBM Maximo.
Where Can I Use This?What Do I Need?
  • Device Security (Managed by Strata Cloud Manager)
  • (Legacy) IoT Security (Standalone portal)
One of the following subscriptions:
  • Device Security subscription for an advanced Device Security product (Enterprise Plus, Industrial OT, or Medical)
  • Device Security X subscription
One of the following Cortex XSOAR setups:
  • A free, cohosted, limited-featured Cortex XSOAR instance
    AND
    A free Cortex XSOAR Engine (on-premises integration)
  • A full-featured Cortex XSOAR server
To set up Device Security to integrate with IBM Maximo, configure Cortex XSOAR with an integration instance and a job to import asset data. Before configuring the integration instance, set up IBM Maximo for integration and have the following information ready:
  • Your IBM Maximo Application Base API URL
  • Your IBM Maximo API key
To integrate Device Security through a cloud-hosted Cortex XSOAR instance with an on-premises IBM Maximo deployment, you must also add a Cortex XSOAR engine to your network. If IBM Maximo is hosted in the cloud, or if you have an on-premises Cortex XSOAR server, you don't need to install a Cortex XSOAR engine.

Cortex XSOAR Engine Installation

An on-premises Cortex XSOAR engine facilitates communications between the Cortex XSOAR cloud and an on-premises IBM Maximo Manage server. To install a Cortex XSOAR engine, follow the Cortex instructions to Install a Cortex XSOAR Engine. For more information about general operating systems and hardware requirements, see the Cortex XSOAR Administrator Guide.
We recommend downloading the Cortex XSOAR engine using the shell installer script and installing it on a Linux machine. This simplifies the deployment by automatically installing all required dependencies and also enables remote engine upgrades.
The on-premises firewall must allow the Cortex XSOAR engine to form HTTPS connections on TCP port 443 to the Cortex cloud at https://<your-domain>.iot.demisto.live/. You can see the URL of your Cortex XSOAR instance when you log in to Device Security and click Integrations and then click Launch Cortex XSOAR. It’s visible in the address bar of the web page displaying the Cortex XSOAR interface.
To create an Cortex XSOAR engine, access the Cortex XSOAR interface (from Device Security, click Integrations and then click Launch Cortex XSOAR). In the Cortex XSOAR UI, click SettingsEngines+ Create New Engine. Choose Shell as the type.
For Cortex XSOAR engine installation instructions, see Engine Installation.
For help troubleshooting Cortex XSOAR engines, including installations, upgrades, connectivity, and permissions, see Troubleshoot Engines and Troubleshoot Integrations Running on Engines.

Configure Device Security and Cortex XSOAR

  1. Log in to Device Security and then access the IBM Maximo instance settings in Cortex XSOAR.
    1. Log in to Device Security and select IntegrationsIntegration ManagementManage Integrations.
      Device Security uses Cortex XSOAR to integrate with IBM Maximo, and the settings you must configure are in the Cortex XSOAR interface.
    2. Launch Cortex XSOAR.
      The Cortex XSOAR interface opens in a new browser tab or window.
    3. Click Settings in the left navigation menu to go to IntegrationsInstances, and search for IBM Maximo to locate it among other instances.
  2. Configure the settings for an IBM Maximo integration instance.
    1. Click the active integration instance settings icon, or click Add instance, to open the settings panel.
    2. Enter the following settings and leave the others at their default values:
      1. Name: Use the default name or enter a new one to help you identify the instance.
      2. Application Base API URL: Enter the URL of your IBM Maximo Manage application.
      3. Integration API Key: Enter the API key for Cortex XSOAR to use to authenticate with IBM Maximo Manage.
      4. (Optional) Learn New Devices: Select if you want to learn new devices from IBM Maximo in addition to enhancing existing assets in Device Security.
      5. (Cloud-based Cortex XSOAR) Run on Single engine: Select if you are using a cloud-based Cortex XSOAR and are integrating with an on-premises IBM Maximo server.
    3. When finished, click Run test or Test.
      If the test is successful, a Success message appears. If not, check that the settings were entered correctly and then test the configuration again.
    4. After the test succeeds, click Save & exit to save your changes and close the settings panel.
  3. Enable the IBM Maximo integration instance.
  4. Create a job for Cortex XSOAR to send or receive information from IBM Maximo.
    Depending on whether you want to import assets or if you want to send device details, alerts, or vulnerabilities, select the appropriate playbook when configuring the job. If you want to run multiple playbooks, you must create separate jobs, one for each playbook. You can also create multiple jobs if you have multiple integration instances.
    1. Click Jobs in the sidebar, and then click New Job to create a new Cortex XSOAR job.
    2. Configure the following settings in the New Job panel:
      1. Recurring: Select this if you want to periodically run the job. Clear it if you want to run the job on-demand.
      2. (Optional) Every: If you selected Recurring, enter a number and set the interval value (Minutes, Hours, Days, or Weeks) and select the days on which to run the job. If you don't select specific days, then the job will run every day by default. This determines how often Cortex XSOAR queries IBM Maximo Manage for information.
        You can configure Queue Handling to determine what happens if a new job starts while an old job is still running.
      3. Name: Enter a name for the job.
      4. Playbook: Select the playbook depending on the type of job you're configuring.
        1. Export Assets from Device Security 3rd Party Integration - IBM Maximo: Export assets and asset information from Device Security to IBM Maximo Manage.
        2. Import Assets from IBM Maximo - Device Security 3rd Party Integration: Import assets and asset information from IBM Maximo Manage to Device Security.
      5. Integration Instance Name: Enter the name of the IBM Maximo integration instance.
  5. Enable the job and run it.
    Check the Job Status for the job you created. If it's Disabled, select its checkbox and then click Enable.
    You can immediately run the job by selecting it and clicking Run now. Otherwise, if you scheduled a recurring job, then the enabled job will run as scheduled.
  6. Return to Device Security and check the status of the IBM Maximo integration instance.
    An integration instance can be in one of the following four states, which Device Security displays in the Status column on the Integrations page:
    • Active — the integration was configured and enabled and is functioning properly.
    • Disabled — either the integration was configured but intentionally disabled or it was never configured and a job that references it is enabled and running.
    • Error — the integration was configured and enabled but is not functioning properly, possibly due to a configuration error or network condition.
    • Inactive — the integration was configured and enabled but no job has run for at least the past 60 minutes.
    When you see that the status of an integration instance is Active, its setup is complete.