ManageEngine Network Configuration Manager
App Vendor: ManageEngine
App Category: Network Security
Connector Version: 1.0.0
API Version: 1.0.0
About App
The ManageEngine Network Configuration Manager is a multi-vendor network change, configuration, and compliance management (NCCCM) solution for switches, routers, firewalls, and other network devices. In Orchestrate, this app helps network administrators in managing the entire life-cycle of device configuration management.
The ManageEngine Network Configuration Manager app is configured with the Orchestrate application to perform the following actions:
Action Name | Description |
|---|---|
Add a non-SNMP device | This action adds a non-SNMP device. |
Add discovery | This action discovers a particular IP address or network. |
Add a new rule | This action adds a new rule. |
Delete compliance policy | This action deletes a specific compliance policy. |
Delete a device | This action deletes a specific device. |
Delete a specific rule | This action deletes a specific rule. |
Delete Show command | This action deletes a specific show command. |
Delete template | This action deletes configlets. |
Get detailed execution result | This action retrieves detailed execution results. |
Get detailed Configlet execution result | This action retrieves a detailed execution result of a configlet. |
Get summary of a device | This action retrieves details of a specific device. |
Get all device types | This action retrieves all device types supported for a particular vendor. |
Get discovery status | This action retrieves the discovery status. |
Execute Configlet | This action executes a specific configlet. |
Execute commands | This action executes a show command. |
Execute DB query | This action executes a query in the database console of NCM. |
Get compliance details | This action retrieves all the devices that violate the compliance policies. |
Get a recent change list | This action retrieves the recent change list. |
Get all SNMP profiles | This action retrieves all the SNMP profiles. |
Get all Configlets | This action retrieves all the configlets. |
Get all devices | This action retrieves all the devices. |
Get execution history | This action retrieves the execution history of configlets. |
Get devices based on OS model | This action retrieves devices based on specific operating system models. |
Matching devices | This action retrieves matching devices on specific criteria. |
Pending requests | This action retrieves all the pending requests for approvals. |
Ping check | This action pings a particular device. |
Show command output | This action displays the output of the show command. |
SNMP referred device details | This action retrieves all the SNMP referred devices details. |
Update Configlet | This action creates a new configlet or updates the existing configlet. |
Get all Vendors | This action retrieves all the vendors supported by the NCM application. |
Configuration Parameters
The following configuration parameters are required for the ManageEngine Network Configuration Manager app to communicate with the ManageEngine Network Configuration Manager enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
API Key | Enter the API key. | Password | Required | |
Base URL | Enter the base URL. Example: "http://abcd.com/" | Text | Required |
Action: Add a Non-SNMP Device
This action adds a non-SNMP device.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Device ID | Enter the device ID. Example: 20013feabbcc820d | Text | Required | |
Device behavior | Enter the device's behavior. Example: "storage" | Text | Required | |
Series | Enter the series name. | Text | Required | |
Model | Enter the model name. | Text | Required | |
Column 1 | Enter the value of the custom column 1. | Text | Required | |
Column 2 | Enter the value of the custom column 2. | Text | Required |
Action: Add Discovery
This action discovers a particular IP address or network.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Timeout | Enter the timeout value in seconds. Example: 3600 | Text | Required | |
Retries | Enter the retries. | Text | Required | |
Discovery type | Enter the discovery type. | Text | Required | |
Host name | Enter the host name. | Text | Required | |
Start IP | Enter the start IP. Example: 192.168.10.102 | Text | Required | |
End IP | Enter the end IP. Example: 192.168.10.110 | Text | Required |
Action: Add a New Rule
This action adds a new rule.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Compliance rule name | Enter the compliance rule name. | Text | Required | |
Duplicate rule name | Enter the duplicate rule name. | Text | Required | |
Compliance rule description | Enter the compliance rule description. | Text | Required | |
Criteria type | Enter the criteria type. | Text | Required | |
Violation severity | Enter the violation severity. | Text | Required | |
Remediation template | Enter the remediation template. | Text | Required | |
Start block configuration | Enter the start block configuration. | Text | Required | |
End block configuration | Enter the end block configuration. | Text | Required | |
Block condition | Enter the block condition. | Text | Required | |
Block condition value | Enter the block condition value. | Text | Required | |
Compliance rule ID | Enter the compliance rule ID. | Text | Required | |
Simple condition | Enter the simple condition. | Text | Required | |
Simple pattern | Enter the simple pattern. | Text | Required | |
Simple allowed count | Enter the simple allowed count. | Text | Required | |
Criteria list | Enter the criteria list. | Text | Required | |
Condition | Enter the condition. | Text | Required | |
Operator | Enter the operator. | Text | Required | |
Pattern | Enter the pattern. | Text | Required |
Action: Delete Compliance Policy
This action deletes a specific compliance policy.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Compliance policy IDs | Enter the compliance policy IDs. | Text | Required |
Action: Delete a Device
This action deletes a specific device.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Device IDs | Enter the device IDs. | Text | Required |
Action: Delete a Specific Rule
This action deletes a specific rule.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Compliance rule ID | Enter the compliance rule ID. | Text | Required |
Action: Delete Show Command
This action deletes a specific show command.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Command ID | Enter the command ID. | Text | Required |
Action: Delete Template
This action deletes configlets.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Configlet IDs | Enter the configlet IDs. | Text | Required |
Action: Get Detailed Execution Result
This action retrieves detailed execution results.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Execution ID | Enter the execution ID. | Text | Required |
Action: Get Detailed Configlet Execution Result
This action retrieves a detailed execution result of a configlet.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Resource ID | Enter the resource ID. | Text | Required | |
Execution ID | Enter the execution ID. | Text | Required |
Action: Get Summary of a Device
This action retrieves details of a specific device.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Device ID | Enter the device ID. | Text | Required | |
IP address | Enter the IP address. | Text | Required |
Action: Get All Device Types
This action retrieves all device types supported for a particular vendor.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Vendor name | Enter the vendor's name. | Text | Required |
Action: Get Discovery Status
This action retrieves the discovery status.
Action Input Parameters
This action does not require any input parameter.
Action: Execute Configlet
This action executes a specific configlet.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Execution type | Enter the execution type. | Text | Required | |
Template name | Enter the template name. | Text | Required | |
Template type | Enter the template type. | Text | Required | |
Assigned resources | Enter the assigned resources. | Text | Required | |
Component selection | Enter the component selection. | Text | Required | |
Device groups selection | Enter the device group selection. | Text | Required | |
Selected devices | Enter the selected devices. | Text | Required | |
Template ID | Enter the template ID. | Text | Required | |
Template contents | Enter the template contents. | Text | Required | |
Backup enabled | Enter backup enabled. | Text | Required | |
Variable name | Enter the variable name. | Text | Required | |
Variables | Enter the variables. | Text | Required |
Action: Execute Commands
This action executes a show command.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Device ID | Enter the device ID. | Text | Required | |
Command | Enter the command. | Text | Required | |
IP address | Enter the IP address. | Text | Required |
Action: Execute DB Query
This action executes a query in the database console of NCM.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Query string | Enter the query string. | Text | Required |
Action: Get Compliance Details
This action retrieves all the devices that violate compliance policies.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Compliance policy ID | Enter the compliance policy ID. | Text | Required | |
Type | Enter the type. | Text | Required | |
Value | Enter the value. | Text | Required |
Action: Get a Recent Change List
This action retrieves the recent change list.
Action Input Parameters
This action does not require any input parameter.
Action: Get All SNMP Profiles
This action retrieves all the SNMP profiles.
Action Input Parameters
This action does not require any input parameter.
Action: Get All Configlets
This action retrieves all the configlets.
Action Input Parameters
This action does not require any input parameter.
Action: Get All Devices
This action retrieves all the device details.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Profile ID | Enter the profile ID. | Text | Required | |
Search string | Enter the search string. | Text | Required | |
Device type | Enter the type of device. Example: "USB" | Text | Required | |
Value | Enter the value. | Text | Required | |
Table data | Enter the table data. | Text | Required | |
OS version | Enter the operating system version. Example: "Windows 10" | Text | Required | |
OS type | Enter the operating system type. Example: "windows" | Text | Required | |
Device type | Enter the device type. | Text | Required | |
Model | Enter the model. | Text | Optional |
Action: Get Execution History
This action retrieves the execution history of configlets.
Action Input Parameters
This action does not require any input parameter.
Action: Get Devices Based on OS Model
This action retrieves devices based on specific operating system models.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Table data | Enter the table data. | Text | Required | |
OS version | Enter the operating system version. | Text | Required | |
OS type | Enter the operating system type. Example: "distributed operating system" | Text | Required | |
Device type | Enter the device type. Example: "USB" | Text | Required | |
Model | Enter the model name. | Text | Optional |
Action: Matching Devices
This action retrieves matching devices on specific criteria.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
IP address | Enter the IP address. | Text | Required | |
Criteria list | Enter the criteria list. | Any | Required | |
Field | Enter the field. | Text | Required | |
Value | Enter the value. | Text | Required | |
Condition | Enter the condition. | Text | Required | |
Comparator | Enter the comparator. | Text | Optional |
Action: Pending Requests
This action retrieves all the pending requests for approvals.
Action Input Parameters
This action does not require any input parameter.
Action: Ping Check
This action pings a particular device.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
IP address | Enter the IP address. | Text | Required |
Action: Show Command Output
This action displays the output of the show command.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Resource ID | Enter the resource ID. | Text | Required | |
Command | Enter the command. | Text | Optional |
Action: SNMP Referred Device Details
This action retrieves all the SNMP referred devices details.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Profile ID | Enter the profile ID. | Text | Required |
Action: Update Configlet
This action creates a new configlet or updates the existing configlet.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Description | Enter the description of the configlet. | Text | Required | |
Contents | Enter the contents of the configlet. | Text | Required | |
Template type | Enter the template type. | Text | Required | |
Template ID | Enter the template ID. | Text | Required | |
Backup enabled | Enter backup enabled. | Text | Required | |
Name | Enter the name of the template. | Text | Required | |
Custom template modified | Enter the modified configlet. | Text | Required |
Action: Get All Vendors
This action retrieves all the vendors supported by the NCM application.
Action Input Parameters
This action does not require any input parameter.