Ivanti Neurons for EPM
App Vendor: Ivanti
App Category: IT Service Management
Connector Version: 1.0.0
API Version: 1.0.0
About App
Ivanti Neurons EPM application is a cloud-based endpoint and user management application that helps security teams to discover threats that touch an organization's network. The tool makes endpoint management easier in every way possible by automating software delivery, reducing login and performance issues, and integrating with multiple IT solutions for quick deployment of response/corrective actions. By employing fewer resources Ivanti Neurons application allows users to manage multiple devices and users to accomplish faster results.
The Ivanti Neurons EPM app built for the Orchestrate application helps security teams to perform asset management-related actions on the Ivanti Neuron EPM application and enable security orchestration workflows. You can execute the following actions using the app.
Action Name | Description |
|---|---|
Create Package | This action creates a package. |
Create Task | This action creates a task. |
Update Task | This action updates a task. |
Add Targets To Task | This action adds targets to a task. |
Get Task Targets | This action retrieves targets of a particular task. |
Get Task Details | This action retrieves details of a task. |
Update Package | This action updates a package. |
Get Package Details | This action retrieves details of a package. |
Reset Package Hash | This action resets package hash. |
List Tasks | This action retrieves the list of tasks. |
List Return Templates | This action retrieves the list of return templates. |
List Packages | This action retrieves the list of packages. |
Configuration Parameters
The following configuration parameters are required for the Ivanti Neuron EPM App to communicate with the Ivanti Neurons EPM application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Base URL | Enter the Base URL, FQDN, or IP address of the server. For example, Base URL as https://<host>.<tld>. | Text | Required | |
Username | Specify the username for the API endpoint. | Text | Required | |
Password | Specify the password for authenticating the API endpoint. | Text | Required | |
Client ID | Specify the client ID for your Ivanti Neuros application. For example, demoapp\anna.harris. | Text | Required | |
Client Secret | Specify the client secret key corresponding to the Client ID. For example, 2cxxxef-e97d-4fb7-bxxx-exxxxx6cxx4a. | Text | Required | |
Verify | Optional preference to either verify or skip the SSL verification. | Boolean | Optional | Allowed values:
Default value:
|
How to connect to EPM APIs?
This section describes how to obtain an access token, client ID, and Client Secret Key to be able to use them and query them from Orchestrate.
First, you will have to register the Orchestrate connector instance in the IdentityServer with a client id and shared secret.
Go the core server and open C:\ProgramData\LANDesk\ServiceDesk\My.IdentityServer
Backup the file IdentityServer3.Core.Models.Client.json
Edit it and add the below data in the beginning, after the first bracket :
{ "Enabled": true, "ClientId": "roclient", "ClientSecrets": [ { "Description": "roclient", "Value": "secret", "Expiration": null, "Type": "SharedSecret" } ], "Flow": 4, "AllowAccessToAllScopes": true, "AllowedScopes": [] },The "secret" will be your shared secret (Client Secret) and "roclient" your client id (Client ID).
Action: Create Package
This action creates a package.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Owner ID | Specify the owner ID for the package. | Integer | Required | |
Name | Specify the name of the package. Example: "examplepackage" | Text | Required | |
Description | Specify the description for the package. Example: "exampledescription" | Text | Required | |
Install | Specify the installation status for the package. Example: "1" | Integer | Optional | |
Command Line | Specify the command line to add to the package. Example: "ls" | Text | Optional | |
Primary File | Specify the primary file to build from the package. | Text | Required | |
Package Type | Specify the package type to build the package. Example: GENERIC_EXE | Text | Required | |
Extra Params | Enter other parameters that need to be added to the package creation request. | Key-Value | Optional |
Note: This action accepts optional parameters such as EstInstallTime, RebootExpected, TimeoutEnabled, AdditionalFiles, EstDownloadTime, ApplicationVendor, DisableClientQueue, ArchitectureOptions, ReturnCodeTemplateId, etc.
Example Input
[
{
"name": "Anna Yeager",
"install": 1,
"owner_id": "1",
"description": "AOT",
"command_line": "ls",
"extra_params": {},
"package_type": "GENERIC_EXE",
"primary_file": "http://server/software/Adobe/AcroRdrDC2000920063_en_US.exe"
}
]Action: Create Task
This action creates a task.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the task name. Example: "ExampleTaskName" | Text | Required | |
Main Package ID | Specify the main package ID to link the task. | Text | Required | |
Status | Specify the status of the task. Example: "Open" | Text | Required | |
Custom Message | Specify the custom message to add to the task. Example: "This is a custom message" | Text | Required |
Note: This action accepts optional parameters such as RescheduleType, RebootSettingsId, RebootSettingsGuid, UseAcceleratedPush, PolicyOperationMode, DistributionAndPatchSettingsId, DistributionAndPatchSettingsGuid, etc.
Example Input
[
{
"name": "beboo",
"status": "Open",
"custom_message": "This is a custom message",
"main_package_id": "1"
}
]Action: Update Task
This action updates a task.
Input Parameter
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Task ID | Enter the task ID to update. | Text | Required | |
Name | Enter the name to update the task. Example: "SampleTask" | Text | Optional | |
Custom Message | Enter the custom message to update the task. Example: "This is a custom message" | Text | Optional | |
Policy Operation Mode | Enter the policy operation mode to update the task. | Text | Optional |
Note: This action accepts optional parameters such as RescheduleType, RebootSettingsId, RebootSettingsGuid, UseAcceleratedPush, PolicyOperationMode, DistributionAndPatchSettingsId, DistributionAndPatchSettingsGuid, etc.
Example Input
[
{
"name": "Updated Name",
"task_id": "4184",
"custom_message": "This message is updated"
}
]Action: Add Targets To Task
This action adds targets to a task.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Task ID | Enter the task ID to update targets. | Integer | Required | |
Target ID | Enter the target ID to add to the task. | Integer | Required | |
Target Type | Enter the target type to add to the task. Example: "DbQuery" | Text | Required | |
Target Name | Enter the target name to add to the task. Example: "policypush" | Text | Required |
Example Input
[
{
"task_id": "4184",
"target_id": "2226",
"target_name": "ISM PolicyPush",
"target_type": "DbQuery"
}
]Action: Get Task Targets
This action retrieves targets of a particular task.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Task ID | Enter the task ID to get the targets. | Integer | Required | |
Expand | Enter the staus to expands related entities inline. Example: "true" | Text | Optional | |
Select | Specify the properties to include in the response. | Text | Optional |
Example Input
[
{
"task_id": "4184",
"expand": "true"
}
]Action: Get Task Details
This action retrieves details of a task.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Task ID | Enter the task ID to get the task details. | Integer | Required | |
Expand | Enter the staus to expands related entities inline. Example: "true" | Text | Optional | |
Select | Specify the properties to include in the response. | Text | Optional |
Example Input
[
{
"task_id": "4184",
"expand": "true"
}
]Action: Update Package
This action updates a package.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Package ID | Enter the package ID to update the details. | Integer | Required | |
Name | Specify the name to update the package. Example: "Updated Name" | Text | Optional | |
Description | Enter the description to update the package. Example: "Example Description" | Text | Optional | |
Install | Enter the install status to update the package. Example: "1" | Integer | Optional | |
Command Line | Enter the command line to update the package. | Text | Optional |
This action accepts optional parameters such as EstInstallTime, RebootExpected, TimeoutEnabled, AdditionalFiles, EstDownloadTime, ApplicationVendor, DisableClientQueue, ArchitectureOptions, ReturnCodeTemplateId, etc.
Example Input
[
{
"name": "Updated Package",
"package_id": "1215",
"description": "AOT"
}
]Action: Get Package Details
This action retrieves details of a package.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Package ID | Enter the package ID to get the details. | Integer | Required | |
Expand | Enter the staus to expands related entities inline. Example: "true" | Text | Optional | |
Select | Specify the properties to include in the response. | Text | Optional |
Example Input
[
{
"package_id": "1215",
"expand":"true"
}
]Action: Reset Package Hash
This action resets package hash.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Package ID | Enter the package ID to reset the package hash. | Integer | Required |
Example Input
[
{
"package_id": "1215"
}
]Action: List Tasks
This action retrieves the list of tasks.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Expand | Enter the staus to expands related entities inline. Example: "true" | Text | Optional | |
Filter | Specify the filter conditions to filter results. | Text | Optional | |
Top | Specify an integer value to return the exact value count from the list. For example, 2. The second value from the list will be returned. | Integer | Optional |
This action accepts optional parameters such as Order By, Select, Skip, etc.
Example Input
[
{
"top": 1,
"expand":"true"
}
]Action: List Return Templates
This action retrieves the list of return templates.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Expand | Enter the staus to expands related entities inline. Example: "true" | Text | Optional | |
Filter | Specify the filter conditions to filter results. | Text | Optional | |
Top | Specify an integer value to return the exact value count from the list. For example, 2. The second value from the list will be returned. | Integer | Optional |
This action accepts optional parameters such as Order By, Select, Skip, etc.
Example Input
[
{
"top": 1,
"expand":"true"
}
]Action: List Packages
This action retrieves the list of packages.
Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Expand | Enter the staus to expands related entities inline. Example: "true" | Text | Optional | |
Filter | Specify the filter conditions to filter results. | Text | Optional | |
Top | Specify an integer value to return the exact value count from the list. For example, 2. The second value from the list will be returned. | Integer | Optional |
This action accepts optional parameters such as Order By, Select, Skip, etc.
Example Input
[
{
"top": 1,
"expand":"true"
}
]