You can define a process automation workflow for Network Configuration Management that can be used to create new rules, compliances, or policies. See Network Configuration Management page for details.

This tutorial walks you through creating a simple remediation process for network configuration management. You can then use this process in Configuration Management > Network Configuration for Remediation Workflow to create a new rule, compliance, or policy.

The following image shows the simple network configuration process definition you will create in this tutorial.


A network configuration process allows you to do the following types of tasks:

TaskDescription
Get Running ConfigRetrieves the pre-defined remediation configurations associated with detected network configuration.
Get Remediation ConfigApproves patches based on filters.
Send to GatewayTransmits the configuration changes you've made to execute on a network device to OpsRamp Gateway.
Get Baseline ConfigRetrieves the baseline configuration for a network device.


Create a New Process for Network Configuration

To create a new network configuration process definition, follow the below steps:

  • Step 1: Define the Process Definition
  • Step 2: Define the Start Event
  • Step 3: Define the Get Remediation Task
  • Step 4: Define the User Approval Task
  • Step 5: Define the Check Approval gateway
  • Step 6: Define the Send to Gateway Task
  • Step 7: Define Response Gateway
  • Step 8: Define Alert Task
  • Step 9: Append the End Event, Save and Deploy

Step 1: Define the Process Definition

Make sure the Remediation and Automation package is enabled for the client.

  1. Login to OpsRamp portal.
  2. Navigate to Automation > Process Automation 2.0. The Process Automation Overview page is displayed.
  3. Click the hamburger icon in the left top corner of the page and select Process Definition. The Process Definition page is displayed.
  4. To add a new process definition, click + ADD. The ADD PROCESS DEFINITION page is displayed.
  5. In the BASIC DETAILS tab, enter the following:
    • Name : A unique name for the process definition.
    • Category: Select Network Configuration.
    • (Optional) Description: Enter additional details about the process.
    • Enable the process definition with the Enable Process Definition toggle.
  6. Click Next. The WORKFLOW tab is displayed.

Step 2: Define the Start Event

The first step of any process is to define the start condition.

  1. Click the Create StartEvent symbol from the component tools menu, and place it on the canvas with a click.
  2. Click the Start Event symbol to display the start event properties.
  3. In the Properties Name. field, enter Start. The ID property is automatically populated.
  4. For the Input Type select Resource.

Step 3: Define the Get Remediation Task

After adding the start event, add tasks to complete the process. The first task is to receive the remediation request.

  1. Click the Start Event, and click Append Task.
  2. Select the task, click the Change type (wrench) icon and select Service Task.
  3. Click the task on the canvas to display the task properties.
  4. Enter GetRemediationfor the Name. The name is displayed in the task symbol as you enter it. The task ID is automatically populated.
  5. Select Network Service for the Service.
  6. Select Run Remediation Config for the Task.
  7. The Remediation config Id field is context sensitive to the objects in the process definition. Enter a value in the Remediation config Id field, for example: $remediationConfigId.

Step 4: Define the User Approval Task

After you receive the remediation request, you need to seek user approval to run the network configuration management task.

  1. Click the Get Remediation task, and click Append Task.
  2. Select the task, click the Change type (wrench) icon and select User Task.
  3. Click the task on the canvas to display the task properties.
  4. Enter UserApproval for the Name. The task ID is automatically populated.
  5. Enter values for Subject and Description fields.
  6. Click the Priority drop-down and select a priority value.

Step 5: Define the Check Approval gateway

After you have received user’s response, you can make the decision whether to send the remediation request to the gateway.

  1. Click the User Approval task, click the Change type (wrench) icon and select Append Gateway.
  2. Click the task on the canvas to display the task properties.
  3. Enter checkApproval for the Name. The task ID is automatically populated.
  4. (Optional) Select the Enable Loop Count checkbox and then select the loop count number from the drop-down.

Step 6: Define the Send to Gateway Task

After Step 5, you decide whether to send the remediation request to the gateway based on user approval. If user approval is received, next task is executed, else, the workflow ends.

  1. Click the check Approval gateway, and click Append Task.
  2. Select the task, click the Change type (wrench) icon and select Service Task.
  3. Click the task on the canvas to display the task properties.
  4. Enter SendToGateway for the Name. The task ID is automatically populated.
  5. Select Network Service for Service.
  6. Select Run Remediation Config for Task.
  7. Enter Resource Id in the format $Start.resource.uuid.
  8. Enter Config Id in the format remediationConfigId.
  9. Enter Config Details in the format $GetRemediation.remediationConfig.

Step 7: Define Response Gateway

After the user response is sent to the gateway, you can decide whether to send a success alert or a failure alert. This is achieved by using another gateway. Follow Step 5 to append another gateway with name GatewayResponse.

Step 8: Define Alert Task

The next step is to define task for success and failure alerts. The following are the steps to create success alert. You can follow the same steps to create a failure alert.

  1. Click the GatewayResponse gateway, and click Append Task.
  2. Select the task, click the Change type (wrench) icon and select Service Task.
  3. Click the task on the canvas to display the task properties.
  4. Enter SuccessAlert for the Name. The task ID is automatically populated.
  5. Select Platform Service for Service.
  6. Select Creat/Update Alert for Task.
  7. Enter Resource Name in the format $Start.resource.uuid.
  8. Enter values for rest of the optional fields.

Step 9: Append the End Event, Save and Deploy

When you are finished defining the network configuration process, add an end event and save and deploy the process definition.

  1. Click the Alert task, and click Append EndEvent.
  2. Click the task on the canvas to display the task properties.
  3. Enter End for the Name.
  4. Click Save & Deploy. The displays in the Process Definitions list.

You can view the newly create process on the Process Definitions Page.