Skip to main content

NCM Runbooks

NCM Runbooks in Motadata AIOps can be created by executing SSH Runbooks, enabling you to automate various tasks and streamline network configuration management. Runbooks allow you to achieve numerous use cases, such as changing the description of all interfaces, modifying VLANs on specific interfaces, enabling SNMP across all devices, and activating SNMP traps on all devices simultaneously.

Once a runbook is created, you can execute it for an NCM device either manually through the NCM Explorer or by scheduling it to run at a specific time. Before scheduling, you need to assign the runbook to the NCM device.

Use Cases for Runbooks​

Here are some of the scenarios for which a Runbook can be employed:

  • Change the Description of All Interfaces at Once: Update the description field for all network interfaces on a device. This is particularly useful for standardizing interface descriptions across multiple devices, making it easier to manage and identify them.

  • Modify VLAN Settings on a Specific Interface: Adjust VLAN settings on a targeted interface. This can include adding, modifying, or removing VLANs, ensuring that your network segments are correctly configured according to your requirements.

  • Enable SNMP Across All Devices at Once: Activate SNMP (Simple Network Management Protocol) on all network devices. This is crucial for network monitoring and management, allowing you to collect valuable performance data and manage devices remotely.

  • Activate SNMP Traps Across All Devices at Once: Enable SNMP traps on all network devices to receive alerts and notifications about specific events. This helps in proactive network management and quick troubleshooting.

NCM Runbook Execution​

Executing a Runbook Manually​

To execute a runbook manually for an NCM device:

  1. Create a Runbook: Ensure that you have created a SSH runbook for the NCM device. Also, ensure that the Apply To NCM option is enabled while creating the SSH Runbook.

  2. Navigate to NCM Explorer: Go to the NCM Explorer and locate the NCM device for which you need to execute the runbook.

  3. Select Execute Runbook: In the Actions column against the device, select the Execute Runbook option.

  4. Choose the Runbook: A list of all runbooks created for the same vendor type as the NCM device will be displayed. Select the runbook to execute. .

  5. Upload CSV (Optional): You can also upload a CSV file to use with the runbook script to execute your custom use cases.

Scheduling a Runbook​

To schedule a runbook for execution at a specific time:

  1. Assign Runbook to Monitor: Ensure the Runbook is assigned to the monitor.
  2. Schedule the Runbook: Refer to the Scheduling a Runbook for detailed steps on how to schedule the runbook.

By leveraging runbooks in Motadata AIOps, you can automate repetitive tasks, ensure consistency across network configurations, and enhance the efficiency of your network management operations. Whether you choose to execute runbooks manually or schedule them for future execution, the flexibility and power of runbooks will help you achieve various network configuration management goals with ease.