Moogsoft Docs

SevOne Reference

This is a reference for the SevOne LAM. and UI integration The SevOne LAM configuration file is located at $MOOGSOFT_HOME/config/sevone_lam.conf.

The following properties are unique to the SevOne LAM and UI integration.

See the LAM and Integration Reference for a full description of all common properties used to configure LAMs and UI integrations.

See the SevOne Documentation for details on SevOne components.

url

The SevOne API URL.

Type

String

Required

Yes

Default

N/A

username

Username of the account used to connect to the SevOne API.

Type

String

Required

Yes

Default

N/A

password

Password of the account used to connect to the SevOne API.

Type

String

Required

Yes, if you are not using encrypted_password.

Default

N/A

encrypted_password

If you are using an encrypted password, enter it into this field and comment the password field. The encrypted_password property overrides password.

Type

String

Required

Yes, if you are not using password.

Default

N/A

page_size

Number of paginated results the SevOne API sends.

Type

Integer

Required

No

Default

100

nms_login

Indicates whether the SevOne API username and password are also valid for SevOne Network Management System (NMS). For an example see the following link. Replace example.sevone.com with your SevOne URL: http://example.sevone.com/api/docs/#!/Authentication/signIn_1

Type

Boolean

Required

No

Default

false

alert_filter

A filter to limit the SevOne alerts to retrieve. Do not use the field timespanBetween as it is overwritten by the LAM. For an example see the following link. Replace example.sevone.com with your SevOne URL: http://example.sevone.com/api/docs/#!/Alerts/filterAlerts_1

Type

String

Required

No

Default

N/A

Example: The example below retrieves alerts related to device IDs 0-4.

alert_filter: 
{ 
    "deviceId": [ 0,1,2,3,4 ] 
}
device_query

A query to retrieve device information for SevOne alerts. Specify the content to return in "fields". All available fields are returned by default. If this property is commented out, SevOne will not query for devices. For an example see the following link. Replace example.sevone.com with your SevOne URL: http://example.sevone.com/api/docs/#!/Devices/filterDevice

Type

String

Required

No

Default

N/A

Example:

device_query:
{
    include_objects: false,
    include_indicators: false,
    include_extended_info: false,
    local_only: true,
    fields: [ "id", "name", "alternateName", "description", "ipAddress", "pollFrequency", "lastDiscovery", "timezone", "numElements", "pluginInfo" ]
}
object_query

A query to retrieve object information for SevOne alerts. Specify the content to return in "fields". All available fields are returned by default. If this property is commented out, SevOne will not query for objects. For an example see the following link. Replace example.sevone.com with your SevOne URL: http://example.sevone.com/api/docs/#!/Objects/filterObjects

Type

String

Required

No

Default

N/A

Example:

object_query:
{
    include_indicators: false,
    include_extended_info: true,
    fields: [ "id", "deviceId", "pluginId", "name", "description", "isEnabled", "isDeleted", "extendedInfo" ]
}
user_query

A query to retrieve information about users assigned to SevOne alerts. Specify the content to return in "fields". All available fields are returned by default. If this property is commented out, SevOne will not query for user data. For an example see the following link. Replace example.sevone.com with your SevOne URL: http://example.sevone.com/api/docs/#!/Users/filterUsers

Type

String

Required

No

Default

N/A

Example:

user_query:
{
    fields: [ "id", "username", "firstName", "lastName", "email", "isActive" ]
{