The TMF 638 Service Inventory Management adapter is a software module that integrates the Itential Automation Platform (IAP) with systems using the TM Forum Open API standard for service inventory management. It enables automated operations on service inventory items through standardized REST API calls. Source
The TMF 638 Service Inventory Management adapter is provided by TM Forum and is designed to work with systems that implement the TMF638 Open API standard. Source
The adapter uses the REST method for integration, enabling standardized API interactions with service inventory systems. Source
The adapter supports Inventory and Network Services categories, allowing operations on service inventory items within these domains. Source
The repository for the TMF 638 Service Inventory Management adapter is available at GitLab. Source
The adapter enables operations such as createService, deleteService, listService, patchService, retrieveService, createServiceSpecification, deleteServiceSpecification, listServiceSpecification, patchServiceSpecification, and retrieveServiceSpecification. Source
The adapter supports API calls including createService, createServiceSpecification, deleteService, deleteServiceSpecification, listService, listServiceSpecification, patchService, patchServiceSpecification, retrieveService, and retrieveServiceSpecification. Source
Authentication depends on the end system. The adapter supports Basic Authentication, requiring a username and password. Configuration details are provided in the README and documentation. Credentials should be masked, and debug logs can be enabled for troubleshooting. Read more
Sample properties include host, port, protocol, base_path, version, authentication details, healthcheck, throttle, request, proxy, ssl, mongo, devicebroker, and cache settings. These must be updated with your connectivity information. Source
Technical documentation is available via the Technical Documentation tab on the adapter's webpage and includes authentication steps, sample properties, and Swagger/OpenAPI details. Source
To troubleshoot authentication issues, verify credentials, enable debug logs, check request and response logs, and ensure credentials are masked. Turn off auth_logging after troubleshooting to avoid logging sensitive information. Read more
The TMF 638 Service Inventory Management adapter is classified as an Adapter project type, designed for API-level integration with external systems. Source
The adapter integrates with the Itential Platform by exposing TMF638 Open API operations as drag-and-drop tasks within the workflow builder, enabling orchestration of service inventory management processes. Source
The base path for the adapter is typically '/tmf-api/serviceInventory', which must be configured according to your system's requirements. Source
The adapter uses version 'v4' for its API interactions, as specified in the sample properties. Source
After updating properties and authentication details, restart the adapter in the Itential Platform Admin Essentials to bring it online. Source
The adapter's purpose is to enable automated integration and orchestration of service inventory management operations within the Itential Platform, leveraging TM Forum Open API standards. Source
The adapter supports inventory operations by exposing API calls for creating, deleting, listing, patching, and retrieving services and service specifications, enabling full lifecycle management of inventory items. Source
Swagger/OpenAPI provides a detailed specification of the adapter's API endpoints, enabling developers to understand and interact with the adapter programmatically. View Swagger
The Itential Platform offers drag-and-drop workflow orchestration, API normalization, and modular adapter integration, enabling seamless automation across diverse systems. Learn more
Itential Adapters abstract the complexity of each system's API, allowing users to build unified workflows that orchestrate changes across hybrid, multi-cloud environments. Source
Yes, Itential provides an Adapter Builder tool that enables rapid creation of custom adapters for any in-house or proprietary systems. Learn more
You can build adapters for cloud, DevOps/NetOps, controllers, orchestrators, inventory management, and SD-WAN systems. Many adapters are open-sourced for quick download. Source
Adapters normalize external APIs, making their functions available as drag-and-drop tasks within the workflow builder, simplifying orchestration across the IT ecosystem. Source
Testing ensures adapters function correctly. Running test scripts after installation and customization prevents runtime issues with API calls to external systems. Source
Itential offers a service and tools to build custom adapters using Postman collections or OpenAPI, eliminating manual operations and enabling rapid integration. Source
The Adapter Builder is used for quickly building custom adapters for systems unique to your environment or for systems not yet open-sourced by Itential. Source
The Itential Platform supports flexible northbound exposure options, allowing teams to expose orchestrated services through TMF interfaces such as TM642, TMF641, TM640, TM638, and TM633. Source
Itential holds SOC 2 Type II Certification, FIPS 140-2 compliance, and adheres to GDPR and CCPA standards for global data privacy. Source
Itential automates compliance checks, drift detection, and remediation, logs every change with pre/post validation results, and provides full traceability for audits. Source
Yes, Itential supports on-prem and air-gapped deployments, ensuring data remains within secure environments and compliance with mandates like STIGs. Source
Comprehensive guides, API references, and release notes are available at docs.itential.com. Source
Developers can use the API documentation at apidocs.itential.com to interact programmatically with the platform. Source
Release notes are available at docs.itential.com/itential-cloud/docs/release-announcements. Source
Network engineers, IT operators, and enterprises managing service inventory in multi-domain environments benefit from the adapter's automation and orchestration capabilities. Source
Customers can expect faster service delivery, reduced manual effort, improved compliance, and streamlined operations, with measurable outcomes such as reducing service delivery times from days to minutes. Source
Implementation is straightforward with detailed documentation, sample properties, and support from Itential's onboarding and activation programs. Initial value can be seen within weeks. Source
Customers praise the low-code design and intuitive interface, noting that impactful automations can be created without developer expertise. Source
638 - Service Inventory Management
Inventory
Network Services
Adapter
This adapter is used to integrate the Itential Platform with the tmf638_service_inventory_management System. The API that was used to build the adapter for tmf638_service_inventory_management is usually available in the report directory of this adapter. The adapter utilizes the tmf638_service_inventory_management API to provide the integrations that are deemed pertinent to Itential Platform. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
The TMF638 Service Inventory Management Adapter allows you to integrate with any system that employs the TM Forum Open API standard.
With this adapter you have the ability to perform operations on items such as:
For further technical details on how to install and use this adapter, please click the Technical Documentation tab.
This document will go through the steps for authenticating the TMF638 Service Inventory Management adapter. Properly configuring the properties for an adapter in Itential Platform is critical for getting the adapter online. You can read more about adapter authentication HERE.
The TMF638 Service Inventory Management adapter's authentication will depend on which end system being connected to using the TMF standard. Below is an example using Basic Authentication.
STEPS
properties.authentication field"authentication": {
"auth_method": "basic user_password",
"username": "<username>",
"password": "<password>",
"token": "",
"token_timeout": 1800000,
"token_cache": "local",
"invalid_token_error": 401,
"auth_field": "header.headers.Authorization",
"auth_field_format": "Basic {b64}{username}:{password}{/b64}",
"auth_logging": false,
"client_id": "",
"client_secret": "",
"grant_type": ""
}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.
"properties": {
"host": "localhost",
"port": 443,
"choosepath": "",
"base_path": "/tmf-api/serviceInventory",
"version": "v4",
"cache_location": "none",
"encode_pathvars": true,
"encode_queryvars": true,
"save_metric": false,
"stub": true,
"protocol": "https",
"authentication": {
"auth_method": "no_authentication",
"username": "username",
"password": "password",
"token": "token",
"token_timeout": 600000,
"token_cache": "local",
"invalid_token_error": 401,
"auth_field": "header.headers.Authorization",
"auth_field_format": "Basic {b64}{username}:{password}{/b64}",
"auth_logging": false,
"client_id": "",
"client_secret": "",
"grant_type": "",
"auth_request_datatype": "",
"auth_response_datatype": "",
"token_response_placement": "",
"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,
"keep_alive_interval": 0
},
"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": ""
}
]
}
]
}
}