app-nso_manager

On this page:

addLockItem

Summary

Add Lock Item

Description

Add a lock item to manually prevent a device from being changed. Configuration commitments to locked devices sent through NSO's commit queue will remain in the queue until the lock is removed.

Route

POST /nso_manager/lockItem/:adapterId

Roles

admin

Parameters

DetailsExampleSchema
Name Type Required Description
adapterId string yes Adapter's name.
devices array yes An array of strings. Each element of the array is the name of a device. Get the list of devices using [API DeviceManager.getDevices]{@link cogs.DeviceManager#getDevices}.
blockOthers boolean yes True or False.

Return

DetailsExampleSchema
Name Type Description
tailf-ncs:output object Status of lock and the Commit Queue ID.