Adapter
Adapter for Integration to Winston Syslog
Overview
This adapter is used to integrate the Itential Automation Platform (IAP) with the WinstonSyslog System. The API that was used to build the adapter for WinstonSyslog is usually available in the report directory of this adapter. The adapter utilizes the WinstonSyslog API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
Details
The Winston Syslog adapter from Itential is used to integrate the Itential Automation Platform (IAP) with Winston Syslog. With this adapter you have the ability to perform operations with Winston Syslog on items such as:
- Create log messages
- Retrieve and process log messages
For further technical details on how to install and use this adapter, please click the Technical Documentation tab.
Winston Syslog
Table of Contents
Specific Adapter Information
Authentication
This document will go through the steps for authenticating the Winston Syslog adapter with. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication HERE.
No Authentication
The Winston Syslog Adapter does not require any authentication.
Sample Properties
Sample Properties can be used to help you configure the adapter in the Itential Automation Platform. You will need to update connectivity information such as the host, port, protocol and credentials.
"properties": {
"host": "rsyslog",
"port": 514,
"base_path": "/",
"version": "1.0",
"cache_location": "none",
"encode_pathvars": true,
"encode_queryvars": true,
"save_metric": false,
"stub": true,
"protocol": "http",
"logProtocol": "udp4",
"minLogLevel": "debug",
"type": "BSD",
"authentication": {
"auth_method": "no_authentication",
"username": "username",
"password": "password",
"token": "token",
"token_timeout": 600000,
"token_cache": "local",
"invalid_token_error": 401,
"auth_field": "",
"auth_field_format": "",
"auth_logging": false,
"client_id": "",
"client_secret": "",
"grant_type": "",
"sensitive": [],
"sso": {
"protocol": "",
"host": "",
"port": 0
},
"multiStepAuthCalls": [
{
"name": "",
"requestFields": {},
"responseFields": {},
"successfullResponseCode": 200
}
]
},
"healthcheck": {
"type": "none",
"frequency": 60000,
"query_object": {},
"addlHeaders": {}
},
"throttle": {
"throttle_enabled": false,
"number_pronghorns": 1,
"sync_async": "sync",
"max_in_queue": 1000,
"concurrent_max": 1,
"expire_timeout": 0,
"avg_runtime": 200,
"priorities": [
{
"value": 0,
"percent": 100
}
]
},
"request": {
"number_redirects": 0,
"number_retries": 3,
"limit_retry_error": [
0
],
"failover_codes": [],
"attempt_timeout": 5000,
"global_request": {
"payload": {},
"uriOptions": {},
"addlHeaders": {},
"authData": {}
},
"healthcheck_on_timeout": true,
"return_raw": false,
"archiving": false,
"return_request": false
},
"proxy": {
"enabled": false,
"host": "",
"port": 1,
"protocol": "http",
"username": "",
"password": ""
},
"ssl": {
"ecdhCurve": "",
"enabled": false,
"accept_invalid_cert": false,
"ca_file": "",
"key_file": "",
"cert_file": "",
"secure_protocol": "",
"ciphers": ""
},
"mongo": {
"host": "",
"port": 0,
"database": "",
"username": "",
"password": "",
"replSet": "",
"db_ssl": {
"enabled": false,
"accept_invalid_cert": false,
"ca_file": "",
"key_file": "",
"cert_file": ""
}
},
"devicebroker": {
"enabled": false,
"getDevice": [
{
"path": "/get/devices/{id}",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"id": "name"
},
"responseDatakey": "",
"responseFields": {
"name": "host",
"ostype": "os",
"ostypePrefix": "system-",
"ipaddress": "attributes.ipaddr",
"port": "443"
}
}
],
"getDevicesFiltered": [
{
"path": "/get/devices",
"method": "GET",
"pagination": {
"offsetVar": "",
"limitVar": "",
"incrementBy": "limit",
"requestLocation": "query"
},
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {},
"responseDatakey": "",
"responseFields": {
"name": "host",
"ostype": "os",
"ostypePrefix": "system-",
"ipaddress": "attributes.ipaddr",
"port": "443"
}
}
],
"isAlive": [
{
"path": "/get/devices/{id}/status",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"id": "name"
},
"responseDatakey": "",
"responseFields": {
"status": "status",
"statusValue": "online"
}
}
],
"getConfig": [
{
"path": "/get/devices/{id}/configPart1",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"id": "name"
},
"responseDatakey": "",
"responseFields": {}
}
],
"getCount": [
{
"path": "/get/devices",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {},
"responseDatakey": "",
"responseFields": {}
}
]
},
"cache": {
"enabled": false,
"entities": [
{
"entityType": "",
"frequency": 1440,
"flushOnFail": false,
"limit": 1000,
"retryAttempts": 5,
"sort": true,
"populate": [
{
"path": "",
"method": "GET",
"pagination": {
"offsetVar": "",
"limitVar": "",
"incrementBy": "limit",
"requestLocation": "query"
},
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {},
"responseDatakey": "",
"responseFields": {}
}
],
"cachedTasks": [
{
"name": "",
"filterField": "",
"filterLoc": ""
}
]
}
]
}
}Swagger
Note: The content for this section may be missing as its corresponding .json file is unavailable. This sections will be updated once adapter-openapi.json file is added.