Built-in Service Types

eNMS provides a rich, built-in suite of Service Types for managing and interacting with network equipment.

Ansible Playbook Service

• Ansible Playbook Service runs an ansible playbook on a set of target devices and returns a JSON formatted result.

Data Extraction Service

Extract some data from the payload with a python query, and optionally post-process the result with a regular expression or a TextFSM template:

• Data Extraction Service.

Data Validation Service

Extract some data from the payload, and validate it against a string or a dictionary. This is used for conducting extra validations of a prior service's result later in a workflow:

• Data Validation Service.

Generic File Transfer Service

Transfer a single file to/from the eNMS server to the device using either SFTP or SCP:

• Generic File Transfer Service.

GIT Action Service

Perform a GIT action on a set of files used or created by a workflow:

• GIT Action Service.

ICMP / TCP Ping Service

Implements a Ping from this automation server to the selected devices from inventory using either ICMP or TCP:

• ICMP / TCP Ping Service.

Mail Notification Service

This service is used to send an automatically generated email to a list of recipients:

• Mail Notification Service.

Mattermost Notification Service

This service will send a message to a mattermost server that is configured in the eNMS settings:

• Mattermost Notification Service.

Napalm Services

Napalm connections are SSH connections to equipment in which a pre-defined set of data is retrieved from the equipment and presented to the user in a structured (dictionary) format. The following are the common parameters for all Napalm services:

• Napalm Common Parameters.

And the specifics for each Napalm service are in their own sections:

• Napalm Data Backup Service.
• Napalm Configuration Service.
• Napalm Getters Service.
• Napalm Ping Service.
• Napalm Rollback Service.
• Napalm Traceroute Service.

Netconf (ncclient) Service

Send an XML payload to a device netconf interface:

• Netconf (ncclient) Service.

Netmiko Services

The Netmiko services provide the ability to perform multiple CLI actions through an SSH connection. The following are the values common to every Netmiko service:

• Netmiko Common Parameters.

And the specifics for each Netmiko service are in their own sections:

• Netmiko Configuration Service.
• Netmiko File Transfer Service.
• Netmiko Data Backup Service.
• Netmiko Prompts Service.
• Netmiko Commands Service.

Python Snippet Service

Runs any python code:

• Python Snippet Service.

REST Call Service

Send a REST call (GET, POST, PUT or DELETE) to a URL with optional payload. The output can be validated with a command / pattern mechanism, like the Netmiko Commands Service:

• REST Call Service.

Scrapli Services

The Netmiko services provide the ability to perform multiple CLI actions through an SSH connection. The following are the values common to every Netmiko service:

• Scrapli Common Parameters.

And the specifics for each Scrapli service are in their own sections:

• Scrapli Commands Service.
• Scrapli Data Backup Service.

Scrapli Netconf Service

Send an XML payload to a device netconf interface using Scrapli:

• Scrapli Netconf Service.

Slack Notification Service

This service will send a message to the slack server that is configured in the eNMS settings:

• Slack Notification Service.

Topology Import Service

Import the network topology from an instance of LibreNMS, Netbox or OpenNMS:

• Topology Import Service.

UNIX Command Service

Runs a UNIX command on the server where eNMS is installed:

• Unix Command Service.

UNIX Shell Service

Runs a BASH script on a target device:

• Unix Shell Service.

Workflow (Subworkflow) Service

Create a subworkflow service and add to the current workflow in Workflow Builder:

• Subworkflow Service.