Versions Compared

Old Version 9

changes.mady.by.user Amit Munwes

Saved on

compared with

New Version Current

changes.mady.by.user Sara Weisz

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this page:

Table of Contents
minLevel1
maxLevel1
include
outlinefalse
indent
styledisc
exclude
typelist
class
printabletrue

Status
colourYellow
titlePOST
Add Device

Expand
title/op/api/v1/devices

Description:

This API adds a device to DPOD and optionally sets up Syslog and WS-M.

Required Roles:

  • OpDashAdminRole

URI:

/op/api/v1/devices

Request:

The request should use the

Status
colourYellow
titlePOST
method with the following URL query parameters:

Name

Required/Optional

Description

Type

Available Options

name

Required

The gateway name in DPOD (must be identical to the System Identifier of the gateway)

String

host

Required

IP Address used to access the gateway.

String

romaPort

Required

The ROMA port configured on this gateway.

String

somaPort

Required

The SOMA port configured on this gateway.

String

somaUser

Required

The user name used to access the monitored devices via SOMA/ROMA.

String

somaPassword

Required

The password of the user name used to access the monitored devices via SOMA/ROMA.

String

  • HOST_ALIAS

  • IP_ADDRESS

logTargetAddressType

Required

Log Target source address type.

String

logTargetAddress

Required

IP Address or host alias.

String

disabledSamplings

Required

Disabled Samplings

  • Use this with caution, only when requested by the support team.

String

  • AUDIT_LOG_GETTER

  • CONFIG_SERVICES

  • DEVICE_RESOURCES

  • DEVICE_SETUP

  • INTERNAL_ALERTS_CHECK_LOGTARGET_MISCONFIG

  • MQ_OBJECTS_STATS

  • SERVICE_RESOURCES

  • OBJECTS_STATUS_MONITOR

  • WSM_AGENTS_STATS

syslogAgentName

Required

Syslog agent name.

String

setupSyslogForDomains

Required

Auto setup Syslog agents for new domains

String

true/false

domainsAnalysisLevel

Required

Log Target Analysis Level, see: Log Target Analysis Levels.

String

wsmAgentName

Required

WS-M agent name.

String

setupWsmForDomains

Required

Auto setup WS-M agents for new domains

String

setupCertificateMonitor

Required

Use Certificate monitor

String

true/false

autoSetupPattern

Required

Domain pattern (use asterisk as wildcard)

String

autoSetupSyslogAgentName

Required

Syslog agent name for new domains.

String

autoSetupWsmAgentName

Required

WS-M agent name for new domains.

String

autoSetupAnalysisLevel

Required

Log Target Analysis Level, see: Log Target Analysis Levels.

String

monitorTxInDefaultDomain

Required

Monitor transactions in default domain.

String

true/false

Response:

Response Type

Example

Description

Successful

Code Block
{"resultCode": "SUCCESS","resultMessage": "Device added successfully"}

Status code: 200
resultCode: SUCCESS
resultMessage: “Device added successfully”

...

Expand
title/op/api/v1/devices/refreshAgents

Description:

This method disables all log targets, sets up host aliases again and re-enables all log targets.
If the device cannot be reached - it will be skipped. Errors or exceptions will not stop the operation.

Required Roles:

  • OpDashAdminRole

URI:

/op/api/v1/devices/refreshAgents

Request:

The request should use the

Status
colourYellow
titlePOST
method with an empty body.

Response:

Response Type

Example

Description

Successful

Code Block
{"resultCode": "SUCCESS","resultMessage": ""}

Status code: 200
resultCode: SUCCESS
resultMessage: “”

...