Itential Automation Platform

BREAKING CHANGES

The following are breaking changes in Itential Automation Platform (IAP) for the 2023.1 release.

NED Validator Removed (2023.1.6)

Itential is removing the NED Validator and replacing it with a pre-built automation named @itentialopensource/cisco-nso.

What should I do?

Refer to the Itential Open Source documentation on how to install and use the Cisco-NSO Pre-Built Automation, which has an asset named Validate Configuration against NED - NSO. Further detail is provided also in the asset ReadMe.

Commit Queue Manager Removed (2023.1.6)

The Commit Queue Manager is removed with no replacement.

What should I do?

Use the NSO native UI for managing commit queues. Cisco NSO includes a commit queues tool for managing a large number of device changes with higher transactional throughput.

Related reading:

• Cisco NSO
• NSO Commit Queues
• Understanding NSO Commit Queues

Null vs. Undefined in Workflows (2023.1.4)

In earlier maintenance releases (2021.1.10, 2021.2.4), Itential made a breaking change where undefined would no longer be inserted into the database as null but instead as ~4undefined. The original intent was to improve how null and undefined were treated, which would then allow IAP to decode it to undefined at runtime. Since then, Itential has discovered (and documented) several use cases where IAP returns null or undefined differently with various tasks.

What should I do?

Since the use of null or undefined is not recommended, this breaking change notice will not apply to everyone.

For those who do utilize null or undefined in their workflows, refer to the illustrative example and matrix presented here: Null vs. Undefined in Workflows.

Automation Catalog Removed (2023.1.0)

All app-automation_catalog functionality is removed in IAP 2023.1, including any Automation Catalog items or elements that are part of importing pre-builts. The application UI will remain in "read-only" mode for a limited time. Users will have to manually migrate Automation Catalog automations to Operations Manager and use it going forward.

What should I do?

For more user detail, see the Automation Catalog product notice.

• If upgrading to IAP 2023.1, you will need to select the automations in Automation Catalog you want to migrate and export them to Operations Manager. Automation export can be performed before or after upgrading IAP.
• If installing IAP for the first time (beginning at 2023.1), no additional action is required.

Beta Feature Removed (2023.1.0)

Within the profile properties of IAP, a beta feature to enable broker validation was removed from the auditProps object. Since this feature was in beta mode and disabled by default, its removal has no impact on the design, functionality, performance or usability of the Itential platform.

What should I do?

No action is required. This notice is for awareness only. Removal of the brokerValidation beta feature has no impact on the IAP 2023.1 feature release.

Dropped Index in Workflows Collection

Previously in IAP, the Workflows Collection in app-workflow_engine had a compound index structure that included an index created with "name" and "type" as keys, and another index created with "name" as the only key. Consequently, for any given query there would be a match on multiple fields in the index. That is, the index would support queries on both the "name" key as well as the "name" and "type" keys, thereby creating redundancy and causing excess overhead in retrieval time.

To eliminate the overhead and reduce the number of indexes, Itential removed (dropped) the "name" index from the Workflows Collection.

What should I do?

Make sure all indexes are up-to-date in your IAP environment:

1. Login to IAP and navigate to Admin Essentials → Profiles.
2. Select the default profile ("Profile 1") and click the Indexing tab.
3. Search for "workflows" in the Collection column search filter.
4. The Total IAP Indexes and Current IAP Indexes should be three (3). The Status column should have a green checkmark.

Failed Login Error Response

The /login API now returns a 401 error status when there is a failed login due to invalid user credentials or a deactivated user account. An error response (message) is displayed in the UI to describe the problem.

{"code":401,"message": "Invalid Credentials: Please check with your Admin to determine if your account needs to be activated or recheck your credentials.","error":"Invalid Credentials"}

What should I do?

Please update any automatic scripts or external systems that call the /login API.

POST /api/login