{"type":"api","title":"Lock/Unlock nodes","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/4ecd3a14-d0be-3ef0-ba5d-c3cd958217a7","info":{"title":"Crosswork Device Lifecycle Management (DLM) Inventory API","description":"Crosswork DLM Inventory APIs allow the user to perform CRUD operations on Crosswork Tags, Credentials, Providers and Nodes.","version":"1.0.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/DLM/nodedbapi-overview.md"}},"swagger":"2.0","basePath":"/crosswork/inventory/v1","schemes":["http","https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","description":"bearer auth","name":"Authorization","in":"header"}}},"spec":{"summary":"Lock/Unlock nodes","description":"Lock/Unlock all the nodes requested or fails all of them.\nRequest Body: RobotNodeLockReq\nResponse Body: RobotNodeLockResp\nDEPRECATED URL : post: /v2/dlm/invmgr/locknode/post","operationId":"NodeDb_lockNode","responses":{"200":{"description":"A successful response.","schema":{"type":"object","properties":{"rc":{"title":"Request return code","type":"string","enum":["NODE_REQ_INVALID","NODE_REQ_SUCCESS","NODE_REQ_FAILURE","NODE_REQ_DEV_NOT_FOUND","NODE_REQ_REJECTED"],"default":"NODE_REQ_INVALID","$$ref":"#/definitions/robotapiRobotNodeReqRc"},"rc_msg":{"type":"string","title":"Return Message"},"owner_cookie":{"type":"string"},"lock_id":{"type":"string"},"start_time":{"type":"string","format":"int64"},"end_time":{"type":"string","format":"int64"}},"example":{"rc":"NODE_REQ_SUCCESS","rc_msg":"Operation success","owner_cookie":"dao","lock_id":"29a12334-fa9e-43c4-b82b-922a01a73940","start_time":"1733976891","end_time":"1733976901"},"$$ref":"#/definitions/robotapiRobotNodeLockResp"}},"default":{"description":"An unexpected error response.","schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"type_url":{"type":"string"},"value":{"type":"string","format":"byte"}},"$$ref":"#/definitions/protobufAny"}}},"example":{"error":"string","code":0,"message":"string","details":[{"type_url":"string","value":"string"}]},"$$ref":"#/definitions/runtimeError"}}},"parameters":[{"name":"body","in":"body","description":"Lock/Unlock all the nodes request","required":true,"schema":{"type":"object","properties":{"state":{"type":"string","enum":["INVALID_STATE","UNLOCKED","LOCKED","ERRORED"],"default":"INVALID_STATE","description":"- ERRORED: Node is in error state. This would happen when LOCK\nowner does not renew or release the state within timeout","title":"Lock state for any entity","$$ref":"#/definitions/robotapiRobotEntityLockState"},"uuids":{"type":"array","items":{"type":"string"},"title":"Node UUIDs"},"owner_cookie":{"type":"string"},"lock_id":{"type":"string"},"timeout":{"type":"string","format":"int64"}},"title":"Used Internally by Applications like NCA and PULSE to lock Devices when using them","$$ref":"#/definitions/robotapiRobotNodeLockReq"}}],"tags":["NodeDb"],"__originalOperationId":"NodeDb_lockNode","consumes":["application/json"],"produces":["application/json"],"security":[{"bearerAuth":[]}],"method":"post","path":"/locknodes"}}