Versions Compared

Version Old Version 9 New Version Current
Changes made by

Amit Munwes

Avi Falah

Saved on

Key

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

User will need an admin or operator access for this API, Unauthorized users will get "401 Unauthorized"

Add and setup a device:

Omitted Boolean parameters are presumed to be false, it's not allowed to setup wsm without setting up log targets
Omit the autoSetupAgentNameand autoSetupPattern parameters if you do not wish to use the automatic domain setup feature.

...

Available report actions via APIs

Add Device / Refresh Agents

Authorization:

Authentication: Basic authentication

Roles: it is recommended to read Role Based Access Control page for understanding build-in and custom roles permissions.

From CLI (example):

Code Block
curl -u username:password https://<dpod hostname>/op/api/v1/devices{{parameters}}

Status
colourYellow
titlePOST
Add Device

Expand
title/op/api/v1/devices/?

...

param1=

...

value1&

...

param2=

...

value2.

...

.

...

Info

Error messages are issued for input validation errors , errors while inserting the device into derby/es and errors that happened during the device-level syslog setup, when an error happens during those steps - the transaction is rolled-back and the device is removed from DPOD, so the command can be issued again without failing on a duplicate device error.
Warning messages are issued for errors that happened while setting up log targets for all domains, setting up wsm for all domains or setting up certificate monitoring, the operation stops, but the transaction will not roll-back from DPOD, so manual steps will be needed in order to complete the setup.

Error - The operation either failed the input validation checks, or started but stopped, the device was rolled back from DPOD.

{
"resultCode": "ERROR",
"resultMessage": "A device with this name already exists, name=wdp6"
}

Warning - the operation started but stopped, we did not roll back the device or any setup done to this point, so the user will need to manually check what was setup and complete it manually.
{
"resultCode": "WARNING",
"resultMessage": "Error setting up WS-M agent for the following domains: Domain: APIMgmt_963162B289, Message: +DPOD WSM agent cannot be reached from the device. Error is: Cannot ping both host and IP address: TCP connection to \"10.0.0.38 port 60020\" failed (connection refused)"
}

Setup all devices' host aliases (for DR)

...

.

URL:

POST - https://{{dpodHostname}}/op/api/v1/devices?param1=value1&param2=value2...

URL Parameters:

Name

Is required

Description

Parameter Type

Data options

name

True

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

String

host

True

IP Address used to access the gateway.

String

romaPort

True

The ROMA port configured on this gateway.

String

somaPort

True

The SOMA port configured on this gateway.

String

somaUser

True

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

String

somaPassword

True

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

String

  • HOST_ALIAS

  • IP_ADDRESS

logTargetAddressType

True

Log Target source address type.

String

logTargetAddress

True

IP Address or host alias.

String

disabledSamplings

True

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

True

Syslog agent name.

String

setupSyslogForDomains

True

Auto setup Syslog agents for new domains

String

true/false

domainsAnalysisLevel

True

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

String

wsmAgentName

True

WS-M agent name.

String

setupWsmForDomains

True

Auto setup WS-M agents for new domains

String

setupCertificateMonitor

True

Use Certificate monitor

String

true/false

autoSetupPattern

True

Domain pattern (use asterisk as wildcard)

String

autoSetupSyslogAgentName

True

Syslog agent name for new domains.

String

autoSetupWsmAgentName

True

WS-M agent name for new domains.

String

autoSetupAnalysisLevel

True

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

String

monitorTxInDefaultDomain

True

Monitor transactions in default domain.

String

true/false

Authorization:

Required Permissions

More info

  1. Administrator role

See roles information here: Role Based Access Control

Response:

Response Type

Example value

Description

Successful

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

Status code: 200

resultCode → SUCCESS

resultMessage → “”

Status
colourYellow
titlePOST
Refresh Agents

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

This service method will disable all log targets, setup host aliases again and re-enable all log targets.
If the device cannot be reached - it will be skipped.
Errors or exceptions will not stop the operation.

URL:

POST - https://{{dpodHostname}}/op/api/v1/devices/refreshAgents

...

Warning - not all the operations were completed for one or more devices, the operation completed successfully for devices that are not mentioned.

...

Authorization:

Required Permissions

More info

  1. Administrator role

See roles information here: Role Based Access Control

Response:

Response Type

Example value

Description

Successful

Code Block
{"resultCode": "

...

SUCCESS",

...

"resultMessage": "Device

...

The operation does not return an "ERROR" status.

...

 added successfully"}

Status code: 200

resultCode → SUCCESS

resultMessage → “Device added successfully”

*Setup all devices host aliases (for DR)