For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI referenceRelease notes
DocumentationAPI referenceRelease notes
  • Platform On-Prem
    • Overview
    • Navigate
    • Search resources
      • Adapter API routes
      • Adapter degraded status
      • Broker principal config setting
      • Enumerations in applications
      • Event system
      • Events
      • Log class
      • Naming conventions
      • Public and trusted methods
      • Run as another user
      • Service brokers
      • Service config property encryption
      • Serving UI directories
      • Table control
  • Apps
    • FlowAI
    • Itential Automation Gateway
  • Resources
    • Itential Academy
    • Version lifecycle
    • Itential MCP
    • Accessibility conformance
    • Get support
    • FAQs
LogoLogo
Open sourceSupportFAQsDocs Home
On this page
  • Degraded connection
  • Emit degraded events
  • Recognize a degraded adapter in Admin Essentials
Platform On-PremDeveloper guide

Adapter degraded status

Was this page helpful?
Previous

Broker principal config setting

Next
Built with

Degraded connection

The degraded status is an additional adapter state alongside the online (connected) and offline (disconnected) statuses. This state is intended for adapters like adapter-nso and others that have multiple connection types.

Some scenarios where the degraded state applies include:

  • The connection is not fully up or fully down.
  • One method of communication for an adapter has been disconnected, but another is still active.
  • The adapter is connected, but with an unstable connection.
  • Some functions related to a mode of communication fail to respond.

Emit degraded events

Add the following code to instances where you would like to send the adapter to the degraded state:

1this.emit("DEGRADED", {
2 reason: 'Reason adapter is degraded (will appear on system page)'
3});

Add the following code to instances where the adapter is no longer degraded and the state should be removed — for example, if a second method of communication comes back online, the connection stabilizes, or a specific call succeeds:

1this.emit("FIXED", {
2 reason: 'Optional'
3});

Recognize a degraded adapter in Admin Essentials

1

Start Itential Platform and Adapter NSO

Start both Itential Platform and Adapter NSO.

2

Connect with default credentials

Connect them using the default admin username and admin password.

Initial setup with admin credentials
3

Verify initial connection status

Check the connection status from Admin Essentials → Profiles → Adapters. Status should show as “Running” and connection as “Online”.

NSO adapter showing online connection status
4

Create a new user in NSO

Create a new user in NSO with the name client.

Creating a new client user in NSO
5

Update adapter credentials

Change the Adapter NSO properties credentials to the newly created user (username and password).

Updating adapter credentials to the client user
6

Verify updated connection status

Go back and check the connection status from Admin Essentials → Profiles → Adapters. Status should show as “Running” and connection as “Online”.

Adapter showing online status with client user credentials
7

Delete the client user from NSO

Go to NSO and delete the client user.

Deleting the client user from NSO
8

Confirm degraded status

Check the connection status from Admin Essentials → Profiles → Adapters. Status should now show as “Running” and connection as “Degraded”.

Adapter showing degraded connection status