Options Added to gNMI API Calls

Prev Next

Breaking Change Notice

The following is a breaking change in Itential Platform for the Automation Gateway Adapter.

Beginning with the 2023.1 release, an "options" field (object) was added to the input variables for the gNMI API calls in adapter-automation_gateway:

For both calls, the options field is elective and not required, and supports both datatype and data encoding. More importantly, adding the options field to the task causes workflows to enter DRAFT status.

Related reading:

gnmiGet (example)

"options": {
    "datatype": "operational",
    "encoding": "json_ietf"
  }

gnmiSet (example)

"options": {
    "encoding": "bytes"
  }

What should I do?

When creating workflows with gnmiSet or gnmiGet tasks, it's important to save the task prior to running the workflow. Otherwise, the workflow will go into DRAFT mode, and users will then have to open and save the task.

If you need additional support or require more information, please contact our Product Support Team.