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
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTAdd lock item
        • POSTapplyTemplates task
        • POSTCheck if a device is alive
        • POSTEvaluate NSO when conditions
        • GETGet a NEDs in NSO
        • GETGet all NEDs detailed
        • GETGet authentication groups
        • GETGet filtered devices
        • GETGet filtered devices from an adapter
        • POSTGet JSON schemas of service models
        • POSTGet leafref values from NSO
        • POSTGet rollback files
        • GETList all authentication groups
        • GETList all NEDs in NSO
        • POSTMake REST actions to NSO
        • POSTrestQuery task
        • POSTRun a Live Status
        • POSTRun a Live Status command
        • POSTRun action
        • POSTRun Live Status commands
        • POSTsetItemNacmGroup task
        • POSTsetLeaf task
        • POSTValidate commit without committing
        • POSTValidate network configuration
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceNso Manager

Add lock item

POST
http://localhost:3000/nso_manager/lockItem/:adapterId
POST
/nso_manager/lockItem/:adapterId
$curl -X POST http://localhost:3000/nso_manager/lockItem/adapterId \
> -H "Content-Type: application/json" \
> -u "<username>:<password>" \
> -d '{}'
1{
2 "tailf-ncs:output": {
3 "commit-queue-id": "1555934576990"
4 }
5}

Adds a lock item to manually prevent a device from being changed. Configuration commitments to locked devices sent through Network Services Orchestrator (NSO)‘s commit queue will remain in the queue until the lock is removed.

Was this page helpful?
Previous

applyTemplates task

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

adapterIdstringRequiredformat: "[A-Za-z]+"
Adapter's name.

Request

request body
devicesstringOptionalformat: "[A-Za-z]+"
An input string for devices
blockOthersbooleanOptional

Response

Status of lock and the Commit Queue ID.
tailf-ncs:outputobject

Errors

500
Internal Server Error