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, such as creating, listing, updating, and deleting services, through standardized REST API calls.
The TMF 638 Service Inventory Management adapter is provided by TM Forum and is available as part of Itential's pre-built adapter collection.
The TMF 638 Service Inventory Management adapter uses REST as its integration method, allowing for standardized, API-driven communication with external systems.
The TMF 638 adapter supports the Inventory and Network Services categories, enabling integration and automation of service inventory management tasks within these domains.
The open-source repository for the TMF 638 Service Inventory Management adapter is available at GitLab.
You can perform operations such as createService, deleteService, listService, patchService, retrieveService, createServiceSpecification, deleteServiceSpecification, listServiceSpecification, patchServiceSpecification, and retrieveServiceSpecification using the TMF 638 adapter.
The TMF 638 Service Inventory Management adapter is classified as an Adapter project type within the Itential ecosystem.
The TMF 638 adapter can integrate with any system that employs the TM Forum Open API standard for service inventory management, enabling broad compatibility across telecom and IT environments.
Technical documentation for the TMF 638 Service Inventory Management adapter is available on the Itential website under the Technical Documentation tab of the adapter's page and in the adapter's GitLab repository.
The TMF 638 adapter supports Basic Authentication, with configuration options for username, password, and token management. The specific method depends on the end system being connected to via the TMF standard.
To configure authentication, set the auth_method to 'basic user_password' and provide the required username and password in the adapter's properties. Detailed steps and sample properties are provided in the adapter's documentation and README file.
If you encounter issues, verify credentials, enable debug logs, check request and response logs, and ensure that authentication logging is turned off after troubleshooting to avoid logging sensitive information. Refer to the troubleshooting section in the documentation for more details.
Sample properties include host, port, protocol, base_path, version, authentication details, healthcheck, throttle, request, proxy, ssl, mongo, devicebroker, and cache settings. These can be customized to match your environment and are documented in the adapter's README.
Yes, Swagger/OpenAPI documentation for the TMF 638 adapter is available in the adapter's report directory and can be accessed via the GitLab repository.
The default base path for the TMF 638 adapter's API is /tmf-api/serviceInventory, but this can be configured as needed in the adapter's properties.
After updating the adapter's properties, restart the adapter to apply the changes. If the properties are set correctly, the adapter should come online and be ready for use.
If authentication fails, double-check your credentials, ensure the correct authentication method is set, and review the adapter logs for error messages. Refer to the troubleshooting section in the documentation for further guidance.
The TMF 638 adapter is designed to mask credentials in logs. Ensure that authentication logging is disabled after troubleshooting to prevent sensitive information from being recorded.
The README file for the TMF 638 Service Inventory Management adapter is available in the adapter's GitLab repository and provides detailed installation and configuration instructions.
The TMF 638 adapter supports version v4 of the TMF 638 Service Inventory Management API by default, as specified in the sample properties.
Yes, you can customize the TMF 638 adapter's properties, including host, port, authentication, and other settings, to match your specific environment and integration requirements.
The TMF 638 adapter enables you to perform create, delete, list, patch, and retrieve operations on both services and service specifications. This allows for comprehensive management of service inventory in systems that support the TM Forum Open API standard. Source
The TMF 638 adapter supports the following API calls: createService, createServiceSpecification, deleteService, deleteServiceSpecification, listService, listServiceSpecification, patchService, patchServiceSpecification, retrieveService, and retrieveServiceSpecification. Source
The adapter abstracts the complexity of the TM Forum Open API, providing standardized, drag-and-drop tasks within the Itential workflow builder. This enables rapid integration and orchestration of service inventory operations without custom development.
Yes, the TMF 638 adapter can be incorporated into multi-domain automation workflows, allowing you to orchestrate changes across network, cloud, and IT systems from a single platform. Source
The adapter leverages Itential's platform governance features, including audit trails and policy enforcement, to ensure that all service inventory changes are tracked and compliant with organizational standards. Source
Yes, the TMF 638 Service Inventory Management adapter is open source and its code is available in the Itential GitLab repository. Source
Yes, the TMF 638 adapter can be used alongside other Itential adapters to build comprehensive, cross-domain automation workflows that span multiple systems and technologies. Source
Adapters in the Itential Platform normalize APIs from external systems, making their functions available as drag-and-drop tasks in workflow builders. This simplifies orchestration and accelerates integration across diverse IT and network environments. Source
It is recommended to run test scripts included with the adapter after installation and any customization to ensure all API calls function correctly. If tests fail, review logs and configuration settings. Source
Yes, if your system is not supported by a pre-built adapter, you can use the Itential Adapter Builder to rapidly create custom adapters for any in-house or proprietary systems. Source
You can build adapters for cloud, DevOps/NetOps, controllers & orchestrators, inventory management, SD-WAN, and more. Many adapters are open-sourced for quick download. Source
The TMF 638 adapter enables organizations to automate service inventory management as part of end-to-end network and IT orchestration, supporting unified governance, compliance, and operational efficiency. Source
Using TM Forum Open API standards ensures interoperability, simplifies integration, and accelerates automation across multi-vendor and multi-domain environments. Source
You need access to the target server, appropriate credentials, and the ability to configure the adapter properties (host, port, authentication, etc.) in the Itential Platform. Refer to the README and documentation for detailed requirements.
Support is available through the Itential Customer Portal and the open-source repository's issue tracker. Documentation and troubleshooting guides are also provided on the Itential website. Customer Portal
The API documentation is available in the adapter's report directory and can be accessed via the GitLab repository. Swagger/OpenAPI files are provided for reference. Swagger
Consult the troubleshooting section in the documentation, review logs, verify configuration, and seek support via the Customer Portal or open-source repository if needed.
Download the latest version from the GitLab repository and follow the installation instructions in the README to update your adapter instance.
Yes, you can participate in discussions and seek help via the open-source repository and the Itential VibeOps Forum. VibeOps Forum
Release notes are available on the Itential documentation site and in the adapter's GitLab repository. Release Notes
You can contribute by submitting issues, feature requests, or pull requests via the GitLab repository. Follow the contribution guidelines provided in the repository.
Yes, training and certification programs are available through Itential Academy to help users master the platform and its adapters. Itential Academy
You can request new features by submitting an issue or feature request in the adapter's GitLab repository or through the Itential Customer Portal.
Any known limitations or issues are documented in the adapter's README and release notes. Review these resources for up-to-date information before deployment.
You can watch the GitLab repository or subscribe to release announcements on the Itential documentation site to receive notifications about updates.
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": ""
}
]
}
]
}
}