In this page:
| Table of Contents |
|---|
| minLevel | 1 |
|---|
| maxLevel | 1 |
|---|
| outline | false |
|---|
| style | disc |
|---|
| type | list |
|---|
| printable | true |
|---|
|
...
...
...
Get
...
curl -X POST \
...
a Gateway
| Expand |
|---|
| title | /op/api/v1/gateways/getByName |
|---|
|
Description:This API retrieves a specific gateway. Required Roles:One of the following: URI:/op/api/v1/gateways/getByName
|
...
"logTargetSourceAddress": "192.168.226.229",
"isDeviceResourcesMonitored": "true",
"isServiceResourcesMonitored": "true",
"reSetupSyslogForDevice": "true",
"reSetupSyslogForAllDomains": "false",
"reSetupWsmForDevice": "false",
"reSetupWsmForAllDomains": "false"
}'
The following fields are mandatory: reSetupSyslogForDevice/reSetupSyslogForAllDomains/reSetupWsmForDevice/reSetupWsmForAllDomains
Result example:
{
"result": {
"id": 103
},
...
-H 'Authorization: Basic YWRtaW46YWRtaW51c2Vy' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-d '{
"name": "datapower1-7dc474c48c-chtpg"
}'
Result example:
{
"result": {
"host": "172.17.100.100",
"id": 103,
"isDeviceResourcesMonitored": true,
"isServiceResourcesMonitored": true,
"logTargetSourceAddress": "192.168.226.229",
"name": "datapower1-7dc474c48c-chtpg",
"somaPort": 5550,
"somaUserName": "admin"
},
"resultCode": "SUCCESS"
}
Update Gateway:
curl -X PUT \
https://<IP>:443/op/api/v1/gateway/<ID> \
-H 'Authorization: Basic YWRtaW46YWRtaW51c2Vy' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-d '{
"name": "datapower1-7dc474c48c-chtpg",
"host": "172.17.100.100",
"somaPort": "5550",
"somaUserName": "admin",
"somaPassword": "admin",
Request:The request should use the method with the following fields in its body: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 | |
Example: | Code Block |
|---|
{
"name": "idg_10_5_0_a"
} |
Successful Response:The response includes the following fields in its resultelement: Name | Description | Type | Available Options |
|---|
id | The ID of the gateway. | Long | | name | The gateway name in DPOD (must be identical to the System Identifier of the gateway) | String | | host | IP Address used to access the gateway. | String | | somaPort | The SOMA port configured on this gateway. | String | | somaUserName | The user name used to access the monitored devices via SOMA/ROMA. | String | | logTargetSourceAddress | IP Address or host alias. | String | | disabledSamplings | Disabled Samplings | String | |
Example: | Code Block |
|---|
{
"resultCode": "SUCCESS",
"result": {
"id": 14,
"name": "idg_10_5_0_a",
"host": "1.1.1.1",
"somaPort": 5550,
"somaUserName": "admin",
"logTargetSourceAddress": "1.1.1.1",
"disabledSamplings": ""
}
} |
|
Edit a Gateway| Expand |
|---|
| title | /op/api/v1/gateway/{{gatewayId}} |
|---|
|
Description:This API edits a specific gateway and re-setup all. Required Roles:One of the following: URI:/op/api/v1/gateway/{{gatewayId}}
Request:The request should use the method with the following URL parameters:Name | Required/Optional | Description | Type | Available Options |
|---|
gatewayId
| Required | The gateway ID. | Long | |
The request should use the method with the following fields in its body:Name | Required/Optional | Description | Type | Available Options |
|---|
name | Optional | The gateway name in DPOD (must be identical to the System Identifier of the gateway) | String | | host | Optional | IP Address used to access the gateway. | String | | somaPort | Optional | The SOMA port configured on this gateway. | String | | somaUserName | Optional | The user name used to access the monitored devices via SOMA/ROMA. | String | | somaPassword | Optional | The password of the user name used to access the monitored devices via SOMA/ROMA. | String | | logTargetSourceAddress | Optional | IP Address or host alias. | String | | disabledSamplings | Optional | Disabled Samplings | String | | reSetupSyslogForDevice | Required | Re-setup Syslog agents for device. | Boolean | | reSetupSyslogForAllDomains | Required | Re-setup Syslog agents for all domains. | Boolean | | reSetupWsmForDevice | Required | Re-setup WS-M agents for device. | Boolean | | reSetupWsmForAllDomains | Required | Re-setup WS-M agents for all domains. | Boolean | |
Example: | Code Block |
|---|
{
"name": "idg_10_5_0_a",
"host": "1.1.1.1",
"somaPort": 5550,
"somaUserName": "admin",
"logTargetSourceAddress": "1.1.1.1",
"disabledSamplings": "AUDIT_LOG_GETTER",
"reSetupSyslogForDevice": true,
"reSetupSyslogForAllDomains": true,
"reSetupWsmForDevice": true,
"reSetupWsmForAllDomains": true
} |
Successful Response:The response includes the following fields in its resultelement: Name | Description | Type | Available Options |
|---|
id | The gateway ID. | Long | |
Example: | Code Block |
|---|
{
"resultCode": "SUCCESS",
"result": {
"id": 14
}
} |
|