.png?sv=2022-11-02&spr=https&st=2025-01-24T00%3A35%3A26Z&se=2025-01-24T00%3A45%3A26Z&sr=c&sp=r&sig=oPHomfudp%2BFTWz9SP%2BsVMemgw2mfWigI1ietd0KsDiU%3D){kind=logo}
Itential Platform Methods
- 17 Jan 2025
-
DarkLight
-
PDF
Itential Platform Methods
- Updated on 17 Jan 2025
-
DarkLight
-
PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
The following methods are deprecated in the 2022.1 release version of the Itential Platform.
Admin Essentials
Deprecations in Admin Essentials are shown in the table below.
| Method | Description | Deprecation Release | Scheduled Removal Release | Replacement |
|---|---|---|---|---|
| GET /admin/services/health | Get the health of all services. | 2021.2 | 2023.1 | GET /health/adapters or GET /health/applications |
Compliance Broker
The Compliance Broker has been completely deprecated. Modify any calls to the Compliance Broker to use direct adapter calls. The following methods have been removed:
| Method | Description | Deprecation Release | Scheduled Removal Release | Replacement |
|---|---|---|---|---|
| getReports | Retrieves compliance reports. | 2021.2 | 2023.1 | None |
| createReport | Publishes a golden config tree as a compliance report. | 2021.2 | 2023.1 | None |
| deleteReport | Deletes a selected golden config tree. | 2021.2 | 2023.1 | None |
| runCompliance | Run golden configuration compliance report. | 2021.2 | 2023.1 | None |
Fault Broker
The Fault Broker has been completely deprecated. Modify any calls to the Fault Broker to use direct adapter calls. The following methods have been removed:
| Method | Description | Deprecation Release | Scheduled Removal Release | Replacement |
|---|---|---|---|---|
| getDeviceFaults | Gets all devices that are currently at fault. | 2021.2 | 2023.1 | None |
| getAllDevicesStatuses | Gets the statuses of all devices. | 2021.2 | 2023.1 | None |
| findDevice | Broker call to find a device. | 2021.2 | 2023.1 | None |
| updateDeviceStatus | Broker call to update a device status. | 2021.2 | 2023.1 | None |
Instance Broker
The Instance Broker has been completely deprecated. Modify any calls to the Instance Broker to use direct adapter calls. The following methods have been removed:
| Method | Description | Deprecation Release | Scheduled Removal Release | Replacement |
|---|---|---|---|---|
| createInstance | Broker call to create an instance. | 2021.2 | 2023.1 | None |
| deleteInstance | Broker call to delete an instance. | 2021.2 | 2023.1 | None |
| describeInstance | Broker call to describe an instance. | 2021.2 | 2023.1 | None |
| describeInstanceStatus | Broker call to describe an instance status. | 2021.2 | 2023.1 | None |
Inventory Broker
The Inventory Broker has been completely deprecated. Modify any calls to the Inventory Broker to use direct adapter calls. The following methods have been removed:
| Method | Description | Deprecation Release | Scheduled Removal Release | Replacement |
|---|---|---|---|---|
| getDevices | Gets all devices from the inventory. | 2021.2 | 2023.1 | None |
| findDevice | Finds a specific device in the inventory. | 2021.2 | 2023.1 | None |
| updateDeviceStatus | Updates a device status in the inventory. | 2021.2 | 2023.1 | None |
Itential-Tools
Deprecations in Itential-Tools are shown in the table below.
| Item | Description | Deprecation Release | Removal Release | Replacement |
|---|---|---|---|---|
| createTemplate | Creates a template. | 2019.2 | 2020.1 | Use NSO out of the box create_template. |
| native2XML | Native to XML. | 2019.2 | 2020.1 | No replacement. |
| doCommand | Executes a command. | 2019.2 | 2020.1 | Use liveStatus or runAction. |
| getYANG | Get YANG module. | 2019.2 | 2020.1 | No replacement. |
NSO Manager Methods
Deprecations in NSO Manager are listed in the table below.
| Method | Description | Deprecation Release | Scheduled Removal Release | Replacement |
|---|---|---|---|---|
| liveStatus | Run a Live Status call in NSO. | 2020.1 | 2021.1 | runCommand |
| liveStatusMany | Run a Live Status call with multiple commands in NSO. | 2020.1 | 2021.1 | runCommands |
Operations Manager
Deprecations in Operations Manager are shown in the table below.
| Method | Description | Deprecation Release | Removal Release | Replacement |
|---|---|---|---|---|
GET /operations-manager/admin/jobs |
Get a list of jobs. | 2021.2 | 2021.2* | None |
* This method has been removed from Operations Manager immediately due to security concerns. For more information, refer to Breaking Changes in Operations Manager.
Performance Broker
The Performance Broker has been completely deprecated. Modify any calls to the Performance Broker to use direct adapter calls. The following methods have been removed:
| Method | Description | Deprecation Release | Scheduled Removal Release | Replacement |
|---|---|---|---|---|
| createSocket | Creates a socket for communication between Netpulse and IAP. | 2021.2 | 2023.1 | None |
| updateLinkCapacity | Updates the link capacity of the interface in Netpulse. | 2021.2 | 2023.1 | None |
| updateLinkLatency | Broker call to update link latency. | 2021.2 | 2023.1 | None |
Persistence Broker
The Persistence Broker has been completely deprecated. Modify any calls to the Persistence Broker to use direct adapter calls. The following methods have been removed:
| Method | Description | Deprecation Release | Scheduled Removal Release | Replacement |
|---|---|---|---|---|
| stash | Stashes data in the shared cache. | 2021.2 | 2023.1 | None |
| fetch | Fetches data from the shared cache. | 2021.2 | 2023.1 | None |
| fetchAll | Fetches all grouped data objects from the shared cache. | 2021.2 | 2023.1 | None |
| purge | Removes a particular object from the cache. | 2021.2 | 2023.1 | None |
| purgeAll | Removes all keys from a group. | 2021.2 | 2023.1 | None |
| create | Creates a new document in the permanent data store. | 2021.2 | 2023.1 | None |
| createMany | Creates many new documents in the permanent data store. | 2021.2 | 2023.1 | None |
| search | Searches for a new document in the permanent data store. | 2021.2 | 2023.1 | None |
| distinct | Finds distinct keys in the permanent data store. | 2021.2 | 2023.1 | None |
| exists | Finds whether a key exists in the permanent data store. | 2021.2 | 2023.1 | None |
| count | Gets a count of items in the permanent data store. | 2021.2 | 2023.1 | None |
| aggregate | Makes an aggregate query on the permanent data store. | 2021.2 | 2023.1 | None |
| filterFields | Makes a filterFields query on the permanent data store. | 2021.2 | 2023.1 | None |
| query | Makes a query on the permanent data store. | 2021.2 | 2023.1 | None |
| searchById | Searches for a document in the permanent data store. | 2021.2 | 2023.1 | None |
| save | Saves a document in the permanent data store. | 2021.2 | 2023.1 | None |
| updateSearched | Updates documents based on search criteria. | 2021.2 | 2023.1 | None |
| findAndModify | Locates and updates documents, then returns updated document. | 2021.2 | 2023.1 | None |
| deleteById | Removes a unique document fromm the permanent data store. | 2021.2 | 2023.1 | None |
| deleteSearched | Removes a set of documents from the permanent data store via filter. | 2021.2 | 2023.1 | None |
Service Manager
The following methods were deprecated in Service Manager due to its NSO specificity and replaced with a direct adapter/broker method, where indicated.
| Method | Description | Deprecation Release | Scheduled Removal Release | Replacement |
|---|---|---|---|---|
| getServiceModelFields | Get service model fields. | 2018.3 | 2021.1 | adapter-nso getServiceInstanceArray |
| deleteInstance | Delete a service instance. | 2018.3 | 2021.1 | service broker deleteServiceInstance |
| deleteServicePaths | Delete service instances using paths. | 2018.3 | 2021.1 | service broker deleteService |
| deleteServicePath | Delete a service instance path. | 2018.3 | 2021.1 | service broker deleteService |
| deleteServicePathDryRun | Delete a service path with dry run. | 2018.3 | 2021.1 | service broker dryRunXML |
| addServiceInstance | Add a service instance. | 2018.3 | 2021.1 | service broker saveServiceInstances |
| setServiceInstanceTenant | Set a tenant for a service instance. | 2018.3 | 2021.1 | No replacement. |
| DryRunService | Perform a dry run on a service. | 2018.3 | 2021.1 | service broker DryRunService |
| dryrunServiceInstance | Perform a dry run on a service instance. | 2018.3 | 2021.1 | adapter dryrunServiceInstance |
| DryRunServiceWithFlags | Perform a dry run on a service instance using the JSON-RPC. | 2018.3 | 2021.1 | service broker dryrunServiceInstance |
| addServiceInstances | Add multiple service instances. | 2018.3 | 2021.1 | service broker saveServiceInstances |
| mapInstanceDataToModel | Map instance data to a service model. | 2018.3 | 2021.1 | No replacement. |
| saveInstance | Save a service instance. | 2018.3 | 2021.1 | service broker saveServiceInstances |
| testInstance | Test a service instance. | 2018.3 | 2021.1 | service broker testServiceInstances |
| getServiceModelDatabase | Get service model from the database. | 2018.3 | 2021.1 | No replacement. |
| updateServiceModelDatabase | Update service model in the database. | 2018.3 | 2021.1 | No replacement. |
| deleteServiceModelFromDatabase | Delete service model from the database. | 2018.3 | 2021.1 | No replacement. |
| updateNSOData | Update NSO data in the database. | 2018.3 | 2021.1 | No replacement. |
| getServiceInstanceObjectTemplate | Get the service instance template. | 2018.3 | 2021.1 | adapter getServiceInstanceObjectTemplate |
Topology Broker
The Topology Broker has been completely deprecated. Modify any calls to the Topology Broker to use direct adapter calls. The following methods have been removed:
| Method | Description | Deprecation Release | Scheduled Removal Release | Replacement |
|---|---|---|---|---|
| getTopologyList | Gets the list of toplogies. | 2021.2 | 2023.1 | None |
| getTopology | Gets a specific topology and its associated information. | 2021.2 | 2023.1 | None |
| getTopologyBackup | Gets the autosaved backup topology from the database. | 2021.2 | 2023.1 | None |
| deleteTopology | Removes a topology from the database. | 2021.2 | 2023.1 | None |
| deleteTopologyBackup | Removes an autosaved topology from the database. | 2021.2 | 2023.1 | None |
| saveTopology | Saves a topology. | 2021.2 | 2023.1 | None |
| saveTopologyBackup | Autsaves a topology backup every five minutes. | 2021.2 | 2023.1 | None |
| addTopology | Adds a topology to the database. | 2021.2 | 2023.1 | None |
| lockTopology | Locks a topology. | 2021.2 | 2023.1 | None |
| unlockTopology | Unlocks a topology. | 2021.2 | 2023.1 | None |
| evaluateCircuitUpgrade | Evaluates if a circuit needs an upgrade and performs one if necesary. | 2021.2 | 2023.1 | None |
Was this article helpful?
