@itentialopensource/adapter-morpheus

# Morpheus ## Table of Contents - [Specific Adapter Information](#specific-adapter-information) - [Authentication](#authentication) - [Sample Properties](#sample-properties) - [Swagger](#swagger) - [Generic Adapter Information](#generic-adapter-information) ## Specific Adapter Information ### Authentication This document will go through the steps for authenticating the Morpheus adapter with OAuth Authentication. Properly configuring the properties for an adapter in Itential Platform is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>. Companies periodically change authentication methods to provide better security. As this happens this section should be updated and contributed/merge back into the adapter repository. #### OAuth Authentication The Morpheus adapter authenticates using OAuth. STEPS 1. Ensure you have access to a Morpheus server and that it is running 2. Follow the steps in the README.md to import the adapter into Itential Platform if you have not already done so 3. Use the properties below for the ```properties.authentication``` field ```json "authentication": { "auth_method": "request_token", "sysId": "sysId", "username": "username", "password": "password", "token": "token", "token_timeout": 1800000, "token_cache": "local", "invalid_token_error": 401, "auth_field": "header.headers.Authorization", "auth_field_format": "Bearer {token}" } ``` you can leave all of the other properties in the authentication section, they will not be used when the auth_method is request_token. 4. Restart the adapter. If your properties were set correctly, the adapter should go online. #### Troubleshooting - Make sure you copied over the correct credentials. - Turn on debug level logs for the adapter in Itential Platform Admin Essentials. - Turn on auth_logging for the adapter in Itential Platform Admin Essentials (adapter properties). - Investigate the logs - in particular: - The FULL REQUEST log to make sure the proper headers are being sent with the request. - The FULL BODY log to make sure the payload is accurate. - The CALL RETURN log to see what the other system is telling us. - Credentials should be ** masked ** by the adapter so make sure you verify token - Remember when you are done to turn auth_logging off as you do not want to log credentials. ### Sample Properties Sample Properties can be used to help you configure the adapter in the Itential Platform. You will need to update connectivity information such as the host, port, protocol and credentials. ```json "properties": { "host": "localhost", "port": 443, "choosepath": "", "base_path": "/api", "version": "", "cache_location": "none", "encode_pathvars": true, "encode_queryvars": true, "save_metric": false, "stub": true, "protocol": "https", "authentication": { "auth_method": "request_token", "sysId": "sysId", "username": "username", "password": "password", "token": "token", "token_timeout": 1800000, "token_cache": "local", "invalid_token_error": 401, "auth_field": "header.headers.Authorization", "auth_field_format": "Bearer {token}", "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": "", "ca_file_content": "", "key_file": "", "cert_file": "", "secure_protocol": "", "ciphers": "" }, "mongo": { "url": "", "host": "", "port": 0, "database": "", "dbAuth": false, "username": "", "password": "", "replSet": "", "addSrv": false, "db_ssl": { "enabled": false, "accept_invalid_cert": false, "ca_file": "", "key_file": "", "cert_file": "" } }, "devicebroker": { "enabled": false, "getDevice": [ { "path": "/not/mapped", "method": "GET", "query": {}, "body": {}, "headers": {}, "handleFailure": "ignore", "requestFields": { "insample": "{port}" }, "responseDatakey": "", "responseFields": { "name": "{this}{||}{that}", "ostype": "{osfield}", "ostypePrefix": "meraki-", "port": "{port}", "ipaddress": "{ip_addr}", "serial": "{serial}" } } ], "getDevicesFiltered": [ { "path": "/not/mapped", "method": "GET", "pagination": { "offsetVar": "", "limitVar": "", "incrementBy": "limit", "requestLocation": "query" }, "query": {}, "body": {}, "headers": {}, "handleFailure": "ignore", "requestFields": {}, "responseDatakey": "", "responseFields": { "name": "{this}{||}{that}", "ostype": "{osfield}", "ostypePrefix": "meraki-", "port": "{port}", "ipaddress": "{ip_addr}", "serial": "{serial}", "id": "{myid}" } } ], "isAlive": [ { "path": "/not/mapped/{devID}", "method": "GET", "query": {}, "body": {}, "headers": {}, "handleFailure": "ignore", "requestFields": { "devID": "{id}" }, "responseDatakey": "", "responseFields": { "status": "return2xx", "statusValue": "AD.200" } } ], "getConfig": [ { "path": "/not/mapped/{devID}", "method": "GET", "query": {}, "body": {}, "headers": {}, "handleFailure": "ignore", "requestFields": { "devID": "{id}" }, "responseDatakey": "", "responseFields": {} } ], "getCount": [ { "path": "/not/mapped", "method": "GET", "query": {}, "body": {}, "headers": {}, "handleFailure": "ignore", "requestFields": {}, "responseDatakey": "", "responseFields": {} } ] }, "cache": { "enabled": false, "entities": [ { "entityType": "device", "frequency": 3600, "flushOnFail": false, "limit": 10000, "retryAttempts": 5, "sort": true, "populate": [ { "path": "/not/mapped", "method": "GET", "pagination": { "offsetVar": "", "limitVar": "", "incrementBy": "limit", "requestLocation": "query" }, "query": {}, "body": {}, "headers": {}, "handleFailure": "ignore", "requestFields": {}, "responseDatakey": "", "responseFields": { "name": "{this}{||}{that}", "ostype": "{osfield}", "ostypePrefix": "meraki-", "port": "{port}", "ipaddress": "{ip_addr}", "serial": "{serial}", "id": "{myid}" } } ], "cachedTasks": [ { "name": "", "filterField": "", "filterLoc": "" } ] } ] } } ``` ### [Swagger](https://gitlab.com/itentialopensource/adapters/adapter-morpheus/-/blob/master/report/adapter-openapi.json) ## [Generic Adapter Information](https://gitlab.com/itentialopensource/adapters/adapter-morpheus/-/blob/master/README.md)