{ "id": "@itentialopensource/adapter-nokia_nsp_device_configurator", "type": "Adapter", "export": "NokiaNspDeviceConfigurator", "title": "Nokia_nsp_device_configurator", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name" : "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type" : "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } }, { "name": "persistFlag", "type": "boolean", "info": "Whether the input properties should be saved", "required": true, "schema": { "title": "persistFlag", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the IAP database", "description": "Moves entities from an adapter into the IAP database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "getAuthBearerToken", "summary": "Get Auth Bearer Token", "description": "Get a token from NSP server for the provided user", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "allOf": [ { "type": "object" }, { "example": { "grant_type": "client_credentials" } } ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "allOf": [ { "title": "GetAuthBearerToken", "required": [ "access_token", "refresh_token", "token_type", "expires_in" ], "type": "object", "properties": { "access_token": { "type": "string" }, "refresh_token": { "type": "string" }, "token_type": { "type": "string" }, "expires_in": { "type": "integer" } }, "example": { "access_token": "VEtOLWFkbWluYjcxY2RiMzMtYWZkMS00ZGY2LWFlMDktMDBiNmQ5OTYwNGQ5", "refresh_token": "UkVUS04tYWRtaW41M2I3YWUwOS1iYzRlLTQ2N2UtOWEwYy0wMDljOTc0YjQ2YWY=", "token_type": "Bearer", "expires_in": 3600 } }, { "example": { "access_token": "VEtOLWFkbWluYjcxY2RiMzMtYWZkMS00ZGY2LWFlMDktMDBiNmQ5OTYwNGQ5", "refresh_token": "UkVUS04tYWRtaW41M2I3YWUwOS1iYzRlLTQ2N2UtOWEwYy0wMDljOTc0YjQ2YWY=", "token_type": "Bearer", "expires_in": 3600 } } ] } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getAuthBearerToken" }, "task": true }, { "name": "gettheRESTCONFRoot", "summary": "1. Get the RESTCONF Root", "description": "In this step discovering the RESTCONF API root is done.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "allOf": [ { "title": "1.GettheRESTCONFRoot", "required": [ "links" ], "type": "object", "properties": { "links": { "type": "array", "items": { "title": "Link", "required": [ "rel", "href" ], "type": "object", "properties": { "rel": { "type": "string" }, "href": { "type": "string" } }, "example": { "rel": "restconf", "href": "/restconf" } }, "description": "" } }, "example": { "links": [ { "rel": "restconf", "href": "/restconf" } ] } }, { "example": { "links": [ { "rel": "restconf", "href": "/restconf" } ] } } ] } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/gettheRESTCONFRoot" }, "task": true }, { "name": "getthedatastore", "summary": "2. Get the data store", "description": "Request to GET the root resource \"/restconf\"", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "allOf": [ { "title": "2.Getthedatastore", "required": [ "ietf-restconf:restconf" ], "type": "object", "properties": { "ietf-restconf:restconf": { "title": "IetfRestconfRestconf", "required": [ "data", "yang-library-version" ], "type": "object", "properties": { "data": { "type": "object" }, "yang-library-version": { "type": "string" } }, "example": { "data": {}, "yang-library-version": "2019-01-04" } } }, "example": { "ietf-restconf:restconf": { "data": {}, "yang-library-version": "2019-01-04" } } }, { "example": { "ietf-restconf:restconf": { "data": {}, "yang-library-version": "2019-01-04" } } } ] } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getthedatastore" }, "task": true }, { "name": "gettheyangLibrary", "summary": "3. Get the yang-library", "description": "Lists the yang modules comprising the data model", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "allOf": [ { "title": "3.Gettheyang-library", "required": [ "ietf-yang-library:yang-library" ], "type": "object", "properties": { "ietf-yang-library:yang-library": { "title": "IetfYangLibraryYangLibrary", "required": [ "content-id", "module-set" ], "type": "object", "properties": { "content-id": { "type": "string" }, "module-set": { "type": "array", "items": { "title": "ModuleSet", "required": [ "name", "module" ], "type": "object", "properties": { "name": { "type": "string" }, "module": { "type": "array", "items": { "title": "Module", "required": [ "name", "revision", "namespace", "conformance-type" ], "type": "object", "properties": { "name": { "type": "string" }, "revision": { "type": "string" }, "namespace": { "type": "string" }, "conformance-type": { "type": "string" } }, "example": { "name": "network-device-mgr", "revision": "2018-06-06", "namespace": "urn:nokia:nsp:mdm:network-device-mgr", "conformance-type": "implement" } }, "description": "" } }, "example": { "name": "NSP-MDC-2019-05-20", "module": [ { "name": "network-device-mgr", "revision": "2018-06-06", "namespace": "urn:nokia:nsp:mdm:network-device-mgr", "conformance-type": "implement" }, { "name": "ietf-yang-library", "revision": "2019-01-04", "namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-library", "conformance-type": "implement" }, { "name": "ietf-yang-schema-mount", "revision": "2017-10-09", "namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-schema-mount", "conformance-type": "implement" }, { "name": "ietf-restconf", "revision": "2016-08-15", "namespace": "urn:ietf:params:xml:ns:yang:ietf-restconf", "conformance-type": "implement" } ] } }, "description": "" } }, "example": { "content-id": "NSP-2019-05-20", "module-set": [ { "name": "NSP-MDC-2019-05-20", "module": [ { "name": "network-device-mgr", "revision": "2018-06-06", "namespace": "urn:nokia:nsp:mdm:network-device-mgr", "conformance-type": "implement" }, { "name": "ietf-yang-library", "revision": "2019-01-04", "namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-library", "conformance-type": "implement" }, { "name": "ietf-yang-schema-mount", "revision": "2017-10-09", "namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-schema-mount", "conformance-type": "implement" }, { "name": "ietf-restconf", "revision": "2016-08-15", "namespace": "urn:ietf:params:xml:ns:yang:ietf-restconf", "conformance-type": "implement" } ] } ] } } }, "example": { "ietf-yang-library:yang-library": { "content-id": "NSP-2019-05-20", "module-set": [ { "name": "NSP-MDC-2019-05-20", "module": [ { "name": "network-device-mgr", "revision": "2018-06-06", "namespace": "urn:nokia:nsp:mdm:network-device-mgr", "conformance-type": "implement" }, { "name": "ietf-yang-library", "revision": "2019-01-04", "namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-library", "conformance-type": "implement" }, { "name": "ietf-yang-schema-mount", "revision": "2017-10-09", "namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-schema-mount", "conformance-type": "implement" }, { "name": "ietf-restconf", "revision": "2016-08-15", "namespace": "urn:ietf:params:xml:ns:yang:ietf-restconf", "conformance-type": "implement" } ] } ] } } }, { "example": { "ietf-yang-library:yang-library": { "content-id": "NSP-2019-05-20", "module-set": [ { "name": "NSP-MDC-2019-05-20", "module": [ { "name": "network-device-mgr", "revision": "2018-06-06", "namespace": "urn:nokia:nsp:mdm:network-device-mgr", "conformance-type": "implement" }, { "name": "ietf-yang-library", "revision": "2019-01-04", "namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-library", "conformance-type": "implement" }, { "name": "ietf-yang-schema-mount", "revision": "2017-10-09", "namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-schema-mount", "conformance-type": "implement" }, { "name": "ietf-restconf", "revision": "2016-08-15", "namespace": "urn:ietf:params:xml:ns:yang:ietf-restconf", "conformance-type": "implement" } ] } ] } } } ] } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/gettheyangLibrary" }, "task": true }, { "name": "gettheschemamounts", "summary": "4. Get the schema mounts", "description": "Request to GET the list of mount points and the yang modules where they are used.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "allOf": [ { "title": "4.Gettheschemamounts", "required": [ "ietf-yang-schema-mounts:schema-mounts" ], "type": "object", "properties": { "ietf-yang-schema-mounts:schema-mounts": { "title": "IetfYangSchemaMountsSchemaMounts", "required": [ "mount-point" ], "type": "object", "properties": { "mount-point": { "type": "array", "items": { "title": "MountPoint", "required": [ "module", "label", "inline" ], "type": "object", "properties": { "module": { "type": "string" }, "label": { "type": "string" }, "inline": { "type": "object" } }, "example": { "module": "ietf-network", "label": "ne-management-nm", "inline": {} } }, "description": "" } }, "example": { "mount-point": [ { "module": "ietf-network", "label": "ne-management-nm", "inline": {} }, { "module": "nsp-network", "label": "node-root", "inline": {} }, { "module": "ietf-network", "label": "system-root", "inline": {} }, { "module": "ietf-network", "label": "protocol-root", "inline": {} }, { "module": "ietf-network", "label": "port-root", "inline": {} }, { "module": "ietf-network", "label": "interfaces-root", "inline": {} }, { "module": "ietf-network", "label": "routing-root", "inline": {} }, { "module": "nsp-service-intent", "label": "intent", "inline": {} }, { "module": "nsp-tunnel-intent", "label": "intent", "inline": {} }, { "module": "network-device-mgr", "label": "root", "inline": {} } ] } } }, "example": { "ietf-yang-schema-mounts:schema-mounts": { "mount-point": [ { "module": "ietf-network", "label": "ne-management-nm", "inline": {} }, { "module": "nsp-network", "label": "node-root", "inline": {} }, { "module": "ietf-network", "label": "system-root", "inline": {} }, { "module": "ietf-network", "label": "protocol-root", "inline": {} }, { "module": "ietf-network", "label": "port-root", "inline": {} }, { "module": "ietf-network", "label": "interfaces-root", "inline": {} }, { "module": "ietf-network", "label": "routing-root", "inline": {} }, { "module": "nsp-service-intent", "label": "intent", "inline": {} }, { "module": "nsp-tunnel-intent", "label": "intent", "inline": {} }, { "module": "network-device-mgr", "label": "root", "inline": {} } ] } } }, { "example": { "ietf-yang-schema-mounts:schema-mounts": { "mount-point": [ { "module": "ietf-network", "label": "ne-management-nm", "inline": {} }, { "module": "nsp-network", "label": "node-root", "inline": {} }, { "module": "ietf-network", "label": "system-root", "inline": {} }, { "module": "ietf-network", "label": "protocol-root", "inline": {} }, { "module": "ietf-network", "label": "port-root", "inline": {} }, { "module": "ietf-network", "label": "interfaces-root", "inline": {} }, { "module": "ietf-network", "label": "routing-root", "inline": {} }, { "module": "nsp-service-intent", "label": "intent", "inline": {} }, { "module": "nsp-tunnel-intent", "label": "intent", "inline": {} }, { "module": "network-device-mgr", "label": "root", "inline": {} } ] } } } ] } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/gettheschemamounts" }, "task": true }, { "name": "getallthenetworkdevices", "summary": "5. Get all the network devices", "description": "Lists all of the NEs known to the MDM server, which are supported by the MDC application, along with the device-specific yang schema mounts", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "allOf": [ { "title": "5.Getallthenetworkdevices", "required": [ "network-device-mgr:network-devices" ], "type": "object", "properties": { "network-device-mgr:network-devices": { "title": "NetworkDeviceMgrNetworkDevices", "required": [ "network-device" ], "type": "object", "properties": { "network-device": { "type": "array", "items": { "title": "NetworkDevice", "required": [ "neId", "type", "version", "root" ], "type": "object", "properties": { "neId": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "root": { "title": "Root", "required": [ "yanglib:yang-library" ], "type": "object", "properties": { "yanglib:yang-library": { "title": "YanglibYangLibrary", "required": [ "content-id", "module-set" ], "type": "object", "properties": { "content-id": { "type": "string" }, "module-set": { "type": "array", "items": { "title": "ModuleSet1", "required": [ "name", "module" ], "type": "object", "properties": { "name": { "type": "string" }, "module": { "type": "array", "items": { "title": "Module1", "required": [ "name", "namespace", "revision" ], "type": "object", "properties": { "name": { "type": "string" }, "namespace": { "type": "string" }, "revision": { "type": "string" } }, "example": { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" } }, "description": "" } }, "example": { "name": "SrosOpenConfigMDCNBI@1.0.0", "module": [ { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" }, { "name": "openconfig-lacp", "namespace": "1.1.0", "revision": "1.1.0" }, { "name": "openconfig-network-instance", "namespace": "0.8.0", "revision": "0.8.0" }, { "name": "openconfig-relay-agent", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-routing-policy", "namespace": "3.0.0", "revision": "3.0.0" }, { "name": "openconfig-lldp", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-mpls", "namespace": "2.3.0", "revision": "2.3.0" }, { "name": "openconfig-acl", "namespace": "1.0.0", "revision": "1.0.0" }, { "name": "openconfig-bgp", "namespace": "3.0.1", "revision": "3.0.1" }, { "name": "openconfig-local-routing", "namespace": "1.0.1", "revision": "1.0.1" } ] } }, "description": "" } }, "example": { "content-id": "NSP-19.6.0", "module-set": [ { "name": "SrosOpenConfigMDCNBI@1.0.0", "module": [ { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" }, { "name": "openconfig-lacp", "namespace": "1.1.0", "revision": "1.1.0" }, { "name": "openconfig-network-instance", "namespace": "0.8.0", "revision": "0.8.0" }, { "name": "openconfig-relay-agent", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-routing-policy", "namespace": "3.0.0", "revision": "3.0.0" }, { "name": "openconfig-lldp", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-mpls", "namespace": "2.3.0", "revision": "2.3.0" }, { "name": "openconfig-acl", "namespace": "1.0.0", "revision": "1.0.0" }, { "name": "openconfig-bgp", "namespace": "3.0.1", "revision": "3.0.1" }, { "name": "openconfig-local-routing", "namespace": "1.0.1", "revision": "1.0.1" } ] } ] } } }, "example": { "yanglib:yang-library": { "content-id": "NSP-19.6.0", "module-set": [ { "name": "SrosOpenConfigMDCNBI@1.0.0", "module": [ { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" }, { "name": "openconfig-lacp", "namespace": "1.1.0", "revision": "1.1.0" }, { "name": "openconfig-network-instance", "namespace": "0.8.0", "revision": "0.8.0" }, { "name": "openconfig-relay-agent", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-routing-policy", "namespace": "3.0.0", "revision": "3.0.0" }, { "name": "openconfig-lldp", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-mpls", "namespace": "2.3.0", "revision": "2.3.0" }, { "name": "openconfig-acl", "namespace": "1.0.0", "revision": "1.0.0" }, { "name": "openconfig-bgp", "namespace": "3.0.1", "revision": "3.0.1" }, { "name": "openconfig-local-routing", "namespace": "1.0.1", "revision": "1.0.1" } ] } ] } } } }, "example": { "neId": "10.10.10.1", "type": "SR-7750", "version": "20.10.R3", "root": { "yanglib:yang-library": { "content-id": "NSP-19.6.0", "module-set": [ { "name": "SrosOpenConfigMDCNBI@1.0.0", "module": [ { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" }, { "name": "openconfig-lacp", "namespace": "1.1.0", "revision": "1.1.0" }, { "name": "openconfig-network-instance", "namespace": "0.8.0", "revision": "0.8.0" }, { "name": "openconfig-relay-agent", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-routing-policy", "namespace": "3.0.0", "revision": "3.0.0" }, { "name": "openconfig-lldp", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-mpls", "namespace": "2.3.0", "revision": "2.3.0" }, { "name": "openconfig-acl", "namespace": "1.0.0", "revision": "1.0.0" }, { "name": "openconfig-bgp", "namespace": "3.0.1", "revision": "3.0.1" }, { "name": "openconfig-local-routing", "namespace": "1.0.1", "revision": "1.0.1" } ] } ] } } } }, "description": "" } }, "example": { "network-device": [ { "neId": "10.10.10.1", "type": "SR-7750", "version": "20.10.R3", "root": { "yanglib:yang-library": { "content-id": "NSP-19.6.0", "module-set": [ { "name": "SrosOpenConfigMDCNBI@1.0.0", "module": [ { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" }, { "name": "openconfig-lacp", "namespace": "1.1.0", "revision": "1.1.0" }, { "name": "openconfig-network-instance", "namespace": "0.8.0", "revision": "0.8.0" }, { "name": "openconfig-relay-agent", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-routing-policy", "namespace": "3.0.0", "revision": "3.0.0" }, { "name": "openconfig-lldp", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-mpls", "namespace": "2.3.0", "revision": "2.3.0" }, { "name": "openconfig-acl", "namespace": "1.0.0", "revision": "1.0.0" }, { "name": "openconfig-bgp", "namespace": "3.0.1", "revision": "3.0.1" }, { "name": "openconfig-local-routing", "namespace": "1.0.1", "revision": "1.0.1" } ] } ] } } }, { "neId": "10.10.10.2", "type": "SR-7750", "version": "20.10.R3", "root": { "yanglib:yang-library": { "content-id": "NSP-19.6.0", "module-set": [ { "name": "SrosOpenConfigMDCNBI@1.0.0", "module": [ { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" }, { "name": "openconfig-lacp", "namespace": "1.1.0", "revision": "1.1.0" }, { "name": "openconfig-network-instance", "namespace": "0.8.0", "revision": "0.8.0" }, { "name": "openconfig-relay-agent", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-routing-policy", "namespace": "3.0.0", "revision": "3.0.0" }, { "name": "openconfig-lldp", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-mpls", "namespace": "2.3.0", "revision": "2.3.0" }, { "name": "openconfig-acl", "namespace": "1.0.0", "revision": "1.0.0" }, { "name": "openconfig-bgp", "namespace": "3.0.1", "revision": "3.0.1" }, { "name": "openconfig-local-routing", "namespace": "1.0.1", "revision": "1.0.1" } ] } ] } } } ] } } }, "example": { "network-device-mgr:network-devices": { "network-device": [ { "neId": "10.10.10.1", "type": "SR-7750", "version": "20.10.R3", "root": { "yanglib:yang-library": { "content-id": "NSP-19.6.0", "module-set": [ { "name": "SrosOpenConfigMDCNBI@1.0.0", "module": [ { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" }, { "name": "openconfig-lacp", "namespace": "1.1.0", "revision": "1.1.0" }, { "name": "openconfig-network-instance", "namespace": "0.8.0", "revision": "0.8.0" }, { "name": "openconfig-relay-agent", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-routing-policy", "namespace": "3.0.0", "revision": "3.0.0" }, { "name": "openconfig-lldp", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-mpls", "namespace": "2.3.0", "revision": "2.3.0" }, { "name": "openconfig-acl", "namespace": "1.0.0", "revision": "1.0.0" }, { "name": "openconfig-bgp", "namespace": "3.0.1", "revision": "3.0.1" }, { "name": "openconfig-local-routing", "namespace": "1.0.1", "revision": "1.0.1" } ] } ] } } }, { "neId": "10.10.10.2", "type": "SR-7750", "version": "20.10.R3", "root": { "yanglib:yang-library": { "content-id": "NSP-19.6.0", "module-set": [ { "name": "SrosOpenConfigMDCNBI@1.0.0", "module": [ { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" }, { "name": "openconfig-lacp", "namespace": "1.1.0", "revision": "1.1.0" }, { "name": "openconfig-network-instance", "namespace": "0.8.0", "revision": "0.8.0" }, { "name": "openconfig-relay-agent", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-routing-policy", "namespace": "3.0.0", "revision": "3.0.0" }, { "name": "openconfig-lldp", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-mpls", "namespace": "2.3.0", "revision": "2.3.0" }, { "name": "openconfig-acl", "namespace": "1.0.0", "revision": "1.0.0" }, { "name": "openconfig-bgp", "namespace": "3.0.1", "revision": "3.0.1" }, { "name": "openconfig-local-routing", "namespace": "1.0.1", "revision": "1.0.1" } ] } ] } } } ] } } }, { "example": { "network-device-mgr:network-devices": { "network-device": [ { "neId": "10.10.10.1", "type": "SR-7750", "version": "20.10.R3", "root": { "yanglib:yang-library": { "content-id": "NSP-19.6.0", "module-set": [ { "name": "SrosOpenConfigMDCNBI@1.0.0", "module": [ { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" }, { "name": "openconfig-lacp", "namespace": "1.1.0", "revision": "1.1.0" }, { "name": "openconfig-network-instance", "namespace": "0.8.0", "revision": "0.8.0" }, { "name": "openconfig-relay-agent", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-routing-policy", "namespace": "3.0.0", "revision": "3.0.0" }, { "name": "openconfig-lldp", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-mpls", "namespace": "2.3.0", "revision": "2.3.0" }, { "name": "openconfig-acl", "namespace": "1.0.0", "revision": "1.0.0" }, { "name": "openconfig-bgp", "namespace": "3.0.1", "revision": "3.0.1" }, { "name": "openconfig-local-routing", "namespace": "1.0.1", "revision": "1.0.1" } ] } ] } } }, { "neId": "10.10.10.2", "type": "SR-7750", "version": "20.10.R3", "root": { "yanglib:yang-library": { "content-id": "NSP-19.6.0", "module-set": [ { "name": "SrosOpenConfigMDCNBI@1.0.0", "module": [ { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" }, { "name": "openconfig-lacp", "namespace": "1.1.0", "revision": "1.1.0" }, { "name": "openconfig-network-instance", "namespace": "0.8.0", "revision": "0.8.0" }, { "name": "openconfig-relay-agent", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-routing-policy", "namespace": "3.0.0", "revision": "3.0.0" }, { "name": "openconfig-lldp", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-mpls", "namespace": "2.3.0", "revision": "2.3.0" }, { "name": "openconfig-acl", "namespace": "1.0.0", "revision": "1.0.0" }, { "name": "openconfig-bgp", "namespace": "3.0.1", "revision": "3.0.1" }, { "name": "openconfig-local-routing", "namespace": "1.0.1", "revision": "1.0.1" } ] } ] } } } ] } } } ] } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getallthenetworkdevices" }, "task": true }, { "name": "getagivennetworkdevice", "summary": "6. Get a given network device", "description": "Device info along with device-specific nodal yang schema mounts", "input": [ { "name": "neId", "type": "string", "info": ": string", "required": true, "schema": { "title": "neId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "allOf": [ { "title": "6.Getagivennetworkdevice", "required": [ "network-device-mgr:network-device" ], "type": "object", "properties": { "network-device-mgr:network-device": { "type": "array", "items": { "title": "NetworkDeviceMgrNetworkDevice", "required": [ "neId", "type", "version", "root" ], "type": "object", "properties": { "neId": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "root": { "title": "Root", "required": [ "yanglib:yang-library" ], "type": "object", "properties": { "yanglib:yang-library": { "title": "YanglibYangLibrary", "required": [ "content-id", "module-set" ], "type": "object", "properties": { "content-id": { "type": "string" }, "module-set": { "type": "array", "items": { "title": "ModuleSet1", "required": [ "name", "module" ], "type": "object", "properties": { "name": { "type": "string" }, "module": { "type": "array", "items": { "title": "Module1", "required": [ "name", "namespace", "revision" ], "type": "object", "properties": { "name": { "type": "string" }, "namespace": { "type": "string" }, "revision": { "type": "string" } }, "example": { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" } }, "description": "" } }, "example": { "name": "SrosOpenConfigMDCNBI@1.0.0", "module": [ { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" }, { "name": "openconfig-lacp", "namespace": "1.1.0", "revision": "1.1.0" }, { "name": "openconfig-network-instance", "namespace": "0.8.0", "revision": "0.8.0" }, { "name": "openconfig-relay-agent", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-routing-policy", "namespace": "3.0.0", "revision": "3.0.0" }, { "name": "openconfig-lldp", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-mpls", "namespace": "2.3.0", "revision": "2.3.0" }, { "name": "openconfig-acl", "namespace": "1.0.0", "revision": "1.0.0" }, { "name": "openconfig-bgp", "namespace": "3.0.1", "revision": "3.0.1" }, { "name": "openconfig-local-routing", "namespace": "1.0.1", "revision": "1.0.1" } ] } }, "description": "" } }, "example": { "content-id": "NSP-19.6.0", "module-set": [ { "name": "SrosOpenConfigMDCNBI@1.0.0", "module": [ { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" }, { "name": "openconfig-lacp", "namespace": "1.1.0", "revision": "1.1.0" }, { "name": "openconfig-network-instance", "namespace": "0.8.0", "revision": "0.8.0" }, { "name": "openconfig-relay-agent", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-routing-policy", "namespace": "3.0.0", "revision": "3.0.0" }, { "name": "openconfig-lldp", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-mpls", "namespace": "2.3.0", "revision": "2.3.0" }, { "name": "openconfig-acl", "namespace": "1.0.0", "revision": "1.0.0" }, { "name": "openconfig-bgp", "namespace": "3.0.1", "revision": "3.0.1" }, { "name": "openconfig-local-routing", "namespace": "1.0.1", "revision": "1.0.1" } ] } ] } } }, "example": { "yanglib:yang-library": { "content-id": "NSP-19.6.0", "module-set": [ { "name": "SrosOpenConfigMDCNBI@1.0.0", "module": [ { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" }, { "name": "openconfig-lacp", "namespace": "1.1.0", "revision": "1.1.0" }, { "name": "openconfig-network-instance", "namespace": "0.8.0", "revision": "0.8.0" }, { "name": "openconfig-relay-agent", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-routing-policy", "namespace": "3.0.0", "revision": "3.0.0" }, { "name": "openconfig-lldp", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-mpls", "namespace": "2.3.0", "revision": "2.3.0" }, { "name": "openconfig-acl", "namespace": "1.0.0", "revision": "1.0.0" }, { "name": "openconfig-bgp", "namespace": "3.0.1", "revision": "3.0.1" }, { "name": "openconfig-local-routing", "namespace": "1.0.1", "revision": "1.0.1" } ] } ] } } } }, "example": { "neId": "10.10.10.1", "type": "SR-7750", "version": "20.10.R3", "root": { "yanglib:yang-library": { "content-id": "NSP-19.6.0", "module-set": [ { "name": "SrosOpenConfigMDCNBI@1.0.0", "module": [ { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" }, { "name": "openconfig-lacp", "namespace": "1.1.0", "revision": "1.1.0" }, { "name": "openconfig-network-instance", "namespace": "0.8.0", "revision": "0.8.0" }, { "name": "openconfig-relay-agent", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-routing-policy", "namespace": "3.0.0", "revision": "3.0.0" }, { "name": "openconfig-lldp", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-mpls", "namespace": "2.3.0", "revision": "2.3.0" }, { "name": "openconfig-acl", "namespace": "1.0.0", "revision": "1.0.0" }, { "name": "openconfig-bgp", "namespace": "3.0.1", "revision": "3.0.1" }, { "name": "openconfig-local-routing", "namespace": "1.0.1", "revision": "1.0.1" } ] } ] } } } }, "description": "" } }, "example": { "network-device-mgr:network-device": [ { "neId": "10.10.10.1", "type": "SR-7750", "version": "20.10.R3", "root": { "yanglib:yang-library": { "content-id": "NSP-19.6.0", "module-set": [ { "name": "SrosOpenConfigMDCNBI@1.0.0", "module": [ { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" }, { "name": "openconfig-lacp", "namespace": "1.1.0", "revision": "1.1.0" }, { "name": "openconfig-network-instance", "namespace": "0.8.0", "revision": "0.8.0" }, { "name": "openconfig-relay-agent", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-routing-policy", "namespace": "3.0.0", "revision": "3.0.0" }, { "name": "openconfig-lldp", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-mpls", "namespace": "2.3.0", "revision": "2.3.0" }, { "name": "openconfig-acl", "namespace": "1.0.0", "revision": "1.0.0" }, { "name": "openconfig-bgp", "namespace": "3.0.1", "revision": "3.0.1" }, { "name": "openconfig-local-routing", "namespace": "1.0.1", "revision": "1.0.1" } ] } ] } } } ] } }, { "example": { "network-device-mgr:network-device": [ { "neId": "10.10.10.1", "type": "SR-7750", "version": "20.10.R3", "root": { "yanglib:yang-library": { "content-id": "NSP-19.6.0", "module-set": [ { "name": "SrosOpenConfigMDCNBI@1.0.0", "module": [ { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" }, { "name": "openconfig-lacp", "namespace": "1.1.0", "revision": "1.1.0" }, { "name": "openconfig-network-instance", "namespace": "0.8.0", "revision": "0.8.0" }, { "name": "openconfig-relay-agent", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-routing-policy", "namespace": "3.0.0", "revision": "3.0.0" }, { "name": "openconfig-lldp", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-mpls", "namespace": "2.3.0", "revision": "2.3.0" }, { "name": "openconfig-acl", "namespace": "1.0.0", "revision": "1.0.0" }, { "name": "openconfig-bgp", "namespace": "3.0.1", "revision": "3.0.1" }, { "name": "openconfig-local-routing", "namespace": "1.0.1", "revision": "1.0.1" } ] } ] } } } ] } } ] } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getagivennetworkdevice" }, "task": true }, { "name": "createMDA", "summary": "Create MDA", "description": "An example of configuration request using RESTCONF URL based on schema mounted from SRO", "input": [ { "name": "neId", "type": "string", "info": ": string", "required": true, "schema": { "title": "neId", "type": "string" } }, { "name": "cardId", "type": "string", "info": ": string", "required": true, "schema": { "title": "cardId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "allOf": [ { "type": "object" }, { "example": { "nokia-conf:mda": [ { "mda-slot": 1, "mda-type": "imm24-1gb-xp-tx" } ] } } ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createMDA" }, "task": true }, { "name": "configureMDA", "summary": "Configure MDA", "description": "In this PUT request the target data resource is a list member, e.g., mda=1, therefore PUT will replace just the targeted list member, based on the key/s. Rest of the list entries will not be affected.\n\nPlease note that if the target data resource is a list e.g. ('mda'), PUT operation will replace the members of the list with new members listed in PUT BODY.", "input": [ { "name": "neId", "type": "string", "info": ": string", "required": true, "schema": { "title": "neId", "type": "string" } }, { "name": "cardId", "type": "string", "info": ": string", "required": true, "schema": { "title": "cardId", "type": "string" } }, { "name": "mdaId", "type": "string", "info": ": string", "required": true, "schema": { "title": "mdaId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "allOf": [ { "type": "object" }, { "example": { "nokia-conf:slot": [ { "mda-slot": 1, "mda-type": "imm24-1gb-xp-tx", "fail-on-error": false } ] } } ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/configureMDA" }, "task": true }, { "name": "deleteMDA", "summary": "Delete MDA", "description": "Delete MDA", "input": [ { "name": "neId", "type": "string", "info": ": string", "required": true, "schema": { "title": "neId", "type": "string" } }, { "name": "cardId", "type": "string", "info": ": string", "required": true, "schema": { "title": "cardId", "type": "string" } }, { "name": "mdaId", "type": "string", "info": ": string", "required": true, "schema": { "title": "mdaId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMDA" }, "task": true }, { "name": "createInterface", "summary": "Create Interface", "description": "In this PUT request the target data resource is a list member, e.g., interface='plain_patch_1', therefore PUT will replace just the targeted list member, based on the key/s. Rest of the list entries will not be affected.\n\nPlease note that if the target data resource is a list e.g. ('interface'), PUT operation will replace the members of the list with new members listed in PUT BODY.", "input": [ { "name": "neId", "type": "string", "info": ": string", "required": true, "schema": { "title": "neId", "type": "string" } }, { "name": "router", "type": "string", "info": ": string", "required": true, "schema": { "title": "router", "type": "string" } }, { "name": "interfaceParam", "type": "string", "info": ": string", "required": true, "schema": { "title": "interfaceParam", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "allOf": [ { "type": "object" }, { "example": { "nokia-conf:interface": [ { "interface-name": "plain_patch_1", "description": "To be modified by plain patch", "ipv4": { "primary": { "address": "10.18.1.1", "prefix-length": 24 } } } ] } } ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createInterface" }, "task": true }, { "name": "getthelistofinterfaces", "summary": "Get the list of interfaces", "description": "Get the list of interfaces", "input": [ { "name": "neId", "type": "string", "info": ": string", "required": true, "schema": { "title": "neId", "type": "string" } }, { "name": "router", "type": "string", "info": ": string", "required": true, "schema": { "title": "router", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "allOf": [ { "title": "Getthelistofinterfaces", "required": [ "nokia-conf:interface" ], "type": "object", "properties": { "nokia-conf:interface": { "type": "array", "items": { "title": "NokiaConfInterface3", "required": [ "ipv4", "interface-name" ], "type": "object", "properties": { "ipv4": { "title": "Ipv4", "required": [ "primary" ], "type": "object", "properties": { "primary": { "title": "Primary", "required": [ "address", "prefix-length" ], "type": "object", "properties": { "address": { "type": "string" }, "prefix-length": { "type": "integer" } }, "example": { "address": "10.18.1.1", "prefix-length": 24 } } }, "example": { "primary": { "address": "10.18.1.1", "prefix-length": 24 } } }, "port": { "type": "string" }, "interface-name": { "type": "string" }, "description": { "type": "string" } }, "example": { "ipv4": { "primary": { "prefix-length": 24, "address": "10.0.0.2" } }, "port": "1/1/1", "interface-name": "if1" } }, "description": "" } }, "example": { "nokia-conf:interface": [ { "ipv4": { "primary": { "prefix-length": 24, "address": "10.0.0.2" } }, "port": "1/1/1", "interface-name": "if1" }, { "ipv4": { "primary": { "prefix-length": 24, "address": "10.18.1.1" } }, "interface-name": "plain_patch_1", "description": "To be modified by plain patch" }, { "ipv4": { "primary": { "prefix-length": 24, "address": "10.18.2.1" } }, "interface-name": "plain_patch_2", "description": "To be modified by plain patch" }, { "ipv4": { "primary": { "prefix-length": 24, "address": "10.18.3.1" } }, "interface-name": "plain_patch_3", "description": "To be modified by plain patch" }, { "ipv4": { "primary": { "prefix-length": 32, "address": "10.10.10.2" } }, "interface-name": "system" } ] } }, { "example": { "nokia-conf:interface": [ { "ipv4": { "primary": { "prefix-length": 24, "address": "10.0.0.2" } }, "port": "1/1/1", "interface-name": "if1" }, { "ipv4": { "primary": { "prefix-length": 24, "address": "10.18.1.1" } }, "interface-name": "plain_patch_1", "description": "To be modified by plain patch" }, { "ipv4": { "primary": { "prefix-length": 24, "address": "10.18.2.1" } }, "interface-name": "plain_patch_2", "description": "To be modified by plain patch" }, { "ipv4": { "primary": { "prefix-length": 24, "address": "10.18.3.1" } }, "interface-name": "plain_patch_3", "description": "To be modified by plain patch" }, { "ipv4": { "primary": { "prefix-length": 32, "address": "10.10.10.2" } }, "interface-name": "system" } ] } } ] } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getthelistofinterfaces" }, "task": true }, { "name": "verifyyangDataJsoninAcceptPatchheader", "summary": "Verify yang-data+json in Accept-Patch header", "description": "Verify yang-data+json in Accept-Patch header", "input": [ { "name": "neId", "type": "string", "info": ": string", "required": true, "schema": { "title": "neId", "type": "string" } }, { "name": "router", "type": "string", "info": ": string", "required": true, "schema": { "title": "router", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/verifyyangDataJsoninAcceptPatchheader" }, "task": true }, { "name": "patchMultipleinterfaces", "summary": "Patch Multiple interfaces", "description": "In this step we are patching two interfaces (plain_patch_1 and plain_patch_3), and this will not impact plain_patch_2 interface and it will remain as before.", "input": [ { "name": "neId", "type": "string", "info": ": string", "required": true, "schema": { "title": "neId", "type": "string" } }, { "name": "router", "type": "string", "info": ": string", "required": true, "schema": { "title": "router", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "allOf": [ { "type": "object" }, { "example": { "nokia-conf:router": [ { "router-name": "Base", "interface": [ { "interface-name": "plain_patch_1", "ipv4": { "primary": { "prefix-length": 28 } } }, { "interface-name": "plain_patch_2", "ipv4": { "primary": { "prefix-length": 29 } } } ] } ] } } ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchMultipleinterfaces" }, "task": true }, { "name": "addEmptytype", "summary": "Add - empty type", "description": "Disable specified interace on Juniper MX5 by setting the empty-type lead 'disable' to the value of an empty string \"\"\n\n(Please note that this example request is for Juniper node)", "input": [ { "name": "jneId", "type": "string", "info": ": string", "required": true, "schema": { "title": "jneId", "type": "string" } }, { "name": "interfaceParam", "type": "string", "info": ": string", "required": true, "schema": { "title": "interfaceParam", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "allOf": [ { "type": "object" }, { "example": { "configuration:interface": [ { "name": "ge-1/0/2", "disable": "" } ] } } ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addEmptytype" }, "task": true }, { "name": "removeEmptytype", "summary": "Remove - empty type", "description": "Enable interface ge-1/0/2 on Juniper MX5 by removing the empty-type leaf 'disable' from the configuration. This is done by setting the value of the leaf 'disable' to null\n\n(Please note that this example request is for Juniper node)", "input": [ { "name": "jneId", "type": "string", "info": ": string", "required": true, "schema": { "title": "jneId", "type": "string" } }, { "name": "interfaceParam", "type": "string", "info": ": string", "required": true, "schema": { "title": "interfaceParam", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/removeEmptytype" }, "task": true }, { "name": "fieldquerytoselectmultiplefieldsunderthetargetresource", "summary": "Field query to select multiple fields under the target resource", "description": "Get only specific fields (description and admin-state) for ports", "input": [ { "name": "fields", "type": "string", "info": ": string", "required": true, "schema": { "title": "fields", "type": "string" } }, { "name": "neId", "type": "string", "info": ": string", "required": true, "schema": { "title": "neId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "allOf": [ { "title": "Fieldquerytoselectmultiplefieldsunderthetargetresource", "required": [ "nokia-conf:port" ], "type": "object", "properties": { "nokia-conf:port": { "type": "array", "items": { "title": "NokiaConfPort", "required": [ "port-id", "admin-state" ], "type": "object", "properties": { "port-id": { "type": "string" }, "admin-state": { "type": "string" } }, "example": { "port-id": "1/1/1", "admin-state": "enable" } }, "description": "" } }, "example": { "nokia-conf:port": [ { "port-id": "1/1/1", "admin-state": "enable" }, { "port-id": "1/1/9", "admin-state": "enable" }, { "port-id": "1/1/10", "admin-state": "enable" } ] } }, { "example": { "nokia-conf:port": [ { "port-id": "1/1/1", "admin-state": "enable" }, { "port-id": "1/1/9", "admin-state": "enable" }, { "port-id": "1/1/10", "admin-state": "enable" } ] } } ] } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/fieldquerytoselectmultiplefieldsunderthetargetresource" }, "task": true }, { "name": "fieldquerywithsubSelectorsofanodeunderthetargetresource", "summary": "Field query with sub-selectors of a node under the target resource", "description": "Field query with sub-selectors of a node under the target resource", "input": [ { "name": "fields", "type": "string", "info": ": string", "required": true, "schema": { "title": "fields", "type": "string" } }, { "name": "neId", "type": "string", "info": ": string", "required": true, "schema": { "title": "neId", "type": "string" } }, { "name": "cardId", "type": "string", "info": ": string", "required": true, "schema": { "title": "cardId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "allOf": [ { "title": "Fieldquerywithsub-selectorsofanodeunderthetargetresource", "required": [ "nokia-conf:card" ], "type": "object", "properties": { "nokia-conf:card": { "type": "array", "items": { "title": "NokiaConfCard", "required": [ "slot-number", "mda" ], "type": "object", "properties": { "slot-number": { "type": "string" }, "mda": { "type": "array", "items": { "title": "Mdum", "required": [ "mda-slot", "mda-type" ], "type": "object", "properties": { "mda-slot": { "type": "integer" }, "mda-type": { "type": "string" } }, "example": { "mda-slot": 1, "mda-type": "m60-10/100eth-tx" } }, "description": "" } }, "example": { "slot-number": "1", "mda": [ { "mda-slot": 1, "mda-type": "m60-10/100eth-tx" }, { "mda-slot": 2, "mda-type": "m10-1gb+1-10gb" } ] } }, "description": "" } }, "example": { "nokia-conf:card": [ { "slot-number": "1", "mda": [ { "mda-slot": 1, "mda-type": "m60-10/100eth-tx" }, { "mda-slot": 2, "mda-type": "m10-1gb+1-10gb" } ] } ] } }, { "example": { "nokia-conf:card": [ { "slot-number": "1", "mda": [ { "mda-slot": 1, "mda-type": "m60-10/100eth-tx" }, { "mda-slot": 2, "mda-type": "m10-1gb+1-10gb" } ] } ] } } ] } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/fieldquerywithsubSelectorsofanodeunderthetargetresource" }, "task": true }, { "name": "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource", "summary": "Field query to retrieve a single child node under the target resource", "description": "Field query to retrieve a single child node under the target resource", "input": [ { "name": "fields", "type": "string", "info": ": string", "required": true, "schema": { "title": "fields", "type": "string" } }, { "name": "neId", "type": "string", "info": ": string", "required": true, "schema": { "title": "neId", "type": "string" } }, { "name": "port", "type": "string", "info": ": string", "required": true, "schema": { "title": "port", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "allOf": [ { "title": "fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource", "required": [ "nokia-conf:port" ], "type": "object", "properties": { "nokia-conf:port": { "type": "array", "items": { "title": "NokiaConfPort1", "required": [ "ethernet", "port-id" ], "type": "object", "properties": { "ethernet": { "title": "Ethernet", "required": [ "lldp" ], "type": "object", "properties": { "lldp": { "title": "Lldp", "required": [ "dest-mac" ], "type": "object", "properties": { "dest-mac": { "type": "array", "items": { "title": "DestMac", "required": [ "mac-type", "tx-tlvs" ], "type": "object", "properties": { "mac-type": { "type": "string" }, "tx-tlvs": { "title": "TxTlvs", "required": [ "sys-cap", "port-desc", "sys-desc", "sys-name" ], "type": "object", "properties": { "sys-cap": { "type": "boolean" }, "port-desc": { "type": "boolean" }, "sys-desc": { "type": "boolean" }, "sys-name": { "type": "boolean" } }, "example": { "sys-cap": true, "port-desc": true, "sys-desc": true, "sys-name": true } } }, "example": { "mac-type": "nearest-bridge", "tx-tlvs": { "sys-cap": true, "port-desc": true, "sys-desc": true, "sys-name": true } } }, "description": "" } }, "example": { "dest-mac": [ { "mac-type": "nearest-bridge", "tx-tlvs": { "sys-cap": true, "port-desc": true, "sys-desc": true, "sys-name": true } } ] } } }, "example": { "lldp": { "dest-mac": [ { "mac-type": "nearest-bridge", "tx-tlvs": { "sys-cap": true, "port-desc": true, "sys-desc": true, "sys-name": true } } ] } } }, "port-id": { "type": "string" } }, "example": { "ethernet": { "lldp": { "dest-mac": [ { "mac-type": "nearest-bridge", "tx-tlvs": { "sys-cap": true, "port-desc": true, "sys-desc": true, "sys-name": true } } ] } }, "port-id": "1/1/1" } }, "description": "" } }, "example": { "nokia-conf:port": [ { "ethernet": { "lldp": { "dest-mac": [ { "mac-type": "nearest-bridge", "tx-tlvs": { "sys-cap": true, "port-desc": true, "sys-desc": true, "sys-name": true } } ] } }, "port-id": "1/1/1" } ] } }, { "example": { "nokia-conf:port": [ { "ethernet": { "lldp": { "dest-mac": [ { "mac-type": "nearest-bridge", "tx-tlvs": { "sys-cap": true, "port-desc": true, "sys-desc": true, "sys-name": true } } ] } }, "port-id": "1/1/1" } ] } } ] } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource" }, "task": true }, { "name": "getQoS", "summary": "Get QoS", "description": "Get QoS", "input": [ { "name": "networkDevice", "type": "string", "info": ": string", "required": true, "schema": { "title": "networkDevice", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "allOf": [ { "title": "GetQoS", "required": [ "nokia-conf:qos" ], "type": "object", "properties": { "nokia-conf:qos": { "title": "NokiaConfQos", "required": [ "sap-egress", "sap-ingress" ], "type": "object", "properties": { "sap-egress": { "type": "array", "items": { "title": "SapEgress", "required": [ "sap-egress-policy-name", "description", "policy-id", "fc", "queue" ], "type": "object", "properties": { "sap-egress-policy-name": { "type": "string" }, "description": { "type": "string" }, "policy-id": { "type": "integer" }, "fc": { "type": "array", "items": { "title": "Fc", "required": [ "fc-name", "queue" ], "type": "object", "properties": { "fc-name": { "type": "string" }, "queue": { "type": "integer" } }, "example": { "fc-name": "be", "queue": 1 } }, "description": "" }, "queue": { "type": "array", "items": { "title": "Queue", "required": [ "queue-id", "rate", "adaptation-rule", "queue-type" ], "type": "object", "properties": { "queue-id": { "type": "integer" }, "rate": { "title": "Rate", "required": [ "pir", "cir" ], "type": "object", "properties": { "pir": { "type": "string" }, "cir": { "type": "string" } }, "example": { "pir": "1000", "cir": "100" } }, "adaptation-rule": { "title": "AdaptationRule", "required": [ "pir", "cir" ], "type": "object", "properties": { "pir": { "type": "string" }, "cir": { "type": "string" } }, "example": { "pir": "max", "cir": "min" } }, "queue-type": { "type": "string" } }, "example": { "queue-id": 1, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "auto-expedited" } }, "description": "" } }, "example": { "sap-egress-policy-name": "Engress5", "description": "Egress QoS 5", "policy-id": 5, "fc": [ { "fc-name": "be", "queue": 1 }, { "fc-name": "l2", "queue": 2 }, { "fc-name": "af", "queue": 3 }, { "fc-name": "l1", "queue": 4 }, { "fc-name": "h2", "queue": 5 }, { "fc-name": "ef", "queue": 6 }, { "fc-name": "h1", "queue": 7 }, { "fc-name": "nc", "queue": 8 } ], "queue": [ { "queue-id": 1, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "auto-expedited" }, { "queue-id": 2, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 3, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 4, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 5, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 6, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 7, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 8, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" } ] } }, "description": "" }, "sap-ingress": { "type": "array", "items": { "title": "SapIngress", "required": [ "ip-criteria", "description", "sap-ingress-policy-name", "policy-id", "fc", "queue" ], "type": "object", "properties": { "ip-criteria": { "title": "IpCriteria", "required": [ "entry" ], "type": "object", "properties": { "entry": { "type": "array", "items": { "title": "Entry", "required": [ "entry-id", "match", "action" ], "type": "object", "properties": { "entry-id": { "type": "integer" }, "match": { "title": "Match", "required": [ "protocol" ], "type": "object", "properties": { "protocol": { "type": "string" } }, "example": { "protocol": "tcp" } }, "action": { "title": "Action", "required": [ "fc" ], "type": "object", "properties": { "fc": { "type": "string" } }, "example": { "fc": "af" } } }, "example": { "entry-id": 10, "match": { "protocol": "tcp" }, "action": { "fc": "af" } } }, "description": "" } }, "example": { "entry": [ { "entry-id": 10, "match": { "protocol": "tcp" }, "action": { "fc": "af" } } ] } }, "description": { "type": "string" }, "sap-ingress-policy-name": { "type": "string" }, "policy-id": { "type": "integer" }, "fc": { "type": "array", "items": { "title": "Fc", "required": [ "fc-name", "queue" ], "type": "object", "properties": { "fc-name": { "type": "string" }, "queue": { "type": "integer" } }, "example": { "fc-name": "be", "queue": 1 } }, "description": "" }, "queue": { "type": "array", "items": { "title": "Queue", "required": [ "queue-id", "rate", "adaptation-rule", "queue-type" ], "type": "object", "properties": { "queue-id": { "type": "integer" }, "rate": { "title": "Rate", "required": [ "pir", "cir" ], "type": "object", "properties": { "pir": { "type": "string" }, "cir": { "type": "string" } }, "example": { "pir": "1000", "cir": "100" } }, "adaptation-rule": { "title": "AdaptationRule", "required": [ "pir", "cir" ], "type": "object", "properties": { "pir": { "type": "string" }, "cir": { "type": "string" } }, "example": { "pir": "max", "cir": "min" } }, "queue-type": { "type": "string" } }, "example": { "queue-id": 1, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "auto-expedited" } }, "description": "" } }, "example": { "ip-criteria": { "entry": [ { "entry-id": 10, "match": { "protocol": "tcp" }, "action": { "fc": "af" } } ] }, "description": "Ingress QoS 1", "sap-ingress-policy-name": "Ingress3", "policy-id": 3, "fc": [ { "fc-name": "af", "queue": 3 }, { "fc-name": "be", "queue": 3 }, { "fc-name": "ef", "queue": 3 }, { "fc-name": "h1", "queue": 3 }, { "fc-name": "h2", "queue": 5 }, { "fc-name": "l1", "queue": 4 }, { "fc-name": "l2", "queue": 2 }, { "fc-name": "nc", "queue": 3 } ], "queue": [ { "queue-id": 1, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "auto-expedited" }, { "queue-id": 2, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 3, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 4, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 5, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 6, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 7, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 8, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" } ] } }, "description": "" } }, "example": { "sap-egress": [ { "sap-egress-policy-name": "Engress5", "description": "Egress QoS 5", "policy-id": 5, "fc": [ { "fc-name": "be", "queue": 1 }, { "fc-name": "l2", "queue": 2 }, { "fc-name": "af", "queue": 3 }, { "fc-name": "l1", "queue": 4 }, { "fc-name": "h2", "queue": 5 }, { "fc-name": "ef", "queue": 6 }, { "fc-name": "h1", "queue": 7 }, { "fc-name": "nc", "queue": 8 } ], "queue": [ { "queue-id": 1, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "auto-expedited" }, { "queue-id": 2, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 3, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 4, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 5, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 6, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 7, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 8, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" } ] } ], "sap-ingress": [ { "ip-criteria": { "entry": [ { "entry-id": 10, "match": { "protocol": "tcp" }, "action": { "fc": "af" } } ] }, "description": "Ingress QoS 1", "sap-ingress-policy-name": "Ingress3", "policy-id": 3, "fc": [ { "fc-name": "af", "queue": 3 }, { "fc-name": "be", "queue": 3 }, { "fc-name": "ef", "queue": 3 }, { "fc-name": "h1", "queue": 3 }, { "fc-name": "h2", "queue": 5 }, { "fc-name": "l1", "queue": 4 }, { "fc-name": "l2", "queue": 2 }, { "fc-name": "nc", "queue": 3 } ], "queue": [ { "queue-id": 1, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "auto-expedited" }, { "queue-id": 2, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 3, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 4, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 5, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 6, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 7, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 8, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" } ] } ] } } }, "example": { "nokia-conf:qos": { "sap-egress": [ { "sap-egress-policy-name": "Engress5", "description": "Egress QoS 5", "policy-id": 5, "fc": [ { "fc-name": "be", "queue": 1 }, { "fc-name": "l2", "queue": 2 }, { "fc-name": "af", "queue": 3 }, { "fc-name": "l1", "queue": 4 }, { "fc-name": "h2", "queue": 5 }, { "fc-name": "ef", "queue": 6 }, { "fc-name": "h1", "queue": 7 }, { "fc-name": "nc", "queue": 8 } ], "queue": [ { "queue-id": 1, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "auto-expedited" }, { "queue-id": 2, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 3, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 4, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 5, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 6, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 7, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 8, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" } ] } ], "sap-ingress": [ { "ip-criteria": { "entry": [ { "entry-id": 10, "match": { "protocol": "tcp" }, "action": { "fc": "af" } } ] }, "description": "Ingress QoS 1", "sap-ingress-policy-name": "Ingress3", "policy-id": 3, "fc": [ { "fc-name": "af", "queue": 3 }, { "fc-name": "be", "queue": 3 }, { "fc-name": "ef", "queue": 3 }, { "fc-name": "h1", "queue": 3 }, { "fc-name": "h2", "queue": 5 }, { "fc-name": "l1", "queue": 4 }, { "fc-name": "l2", "queue": 2 }, { "fc-name": "nc", "queue": 3 } ], "queue": [ { "queue-id": 1, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "auto-expedited" }, { "queue-id": 2, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 3, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 4, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 5, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 6, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 7, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 8, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" } ] } ] } } }, { "example": { "nokia-conf:qos": { "sap-egress": [ { "sap-egress-policy-name": "Engress5", "description": "Egress QoS 5", "policy-id": 5, "fc": [ { "fc-name": "be", "queue": 1 }, { "fc-name": "l2", "queue": 2 }, { "fc-name": "af", "queue": 3 }, { "fc-name": "l1", "queue": 4 }, { "fc-name": "h2", "queue": 5 }, { "fc-name": "ef", "queue": 6 }, { "fc-name": "h1", "queue": 7 }, { "fc-name": "nc", "queue": 8 } ], "queue": [ { "queue-id": 1, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "auto-expedited" }, { "queue-id": 2, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 3, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 4, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 5, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 6, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 7, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 8, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" } ] } ], "sap-ingress": [ { "ip-criteria": { "entry": [ { "entry-id": 10, "match": { "protocol": "tcp" }, "action": { "fc": "af" } } ] }, "description": "Ingress QoS 1", "sap-ingress-policy-name": "Ingress3", "policy-id": 3, "fc": [ { "fc-name": "af", "queue": 3 }, { "fc-name": "be", "queue": 3 }, { "fc-name": "ef", "queue": 3 }, { "fc-name": "h1", "queue": 3 }, { "fc-name": "h2", "queue": 5 }, { "fc-name": "l1", "queue": 4 }, { "fc-name": "l2", "queue": 2 }, { "fc-name": "nc", "queue": 3 } ], "queue": [ { "queue-id": 1, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "auto-expedited" }, { "queue-id": 2, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 3, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 4, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 5, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 6, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 7, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 8, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" } ] } ] } } } ] } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getQoS" }, "task": true }, { "name": "createQOSPolicy", "summary": "Create QOS Policy", "description": "Create QOS Policy", "input": [ { "name": "neId", "type": "string", "info": "network device id", "required": true, "schema": { "title": "neId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "allOf": [ { "type": "object" }, { "example": { "nokia-conf:sap-egress": [ { "sap-egress-policy-name": "Engress6_Test", "description": "Egress QoS 6-Test", "policy-id": 6 } ] } } ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createQOSPolicy" }, "task": true }, { "name": "getQOSSAPEgressPolicy", "summary": "Get QOS SAP Egress Policy", "description": "Get QOS SAP Egress Policy", "input": [ { "name": "networkDevice", "type": "string", "info": ": string", "required": true, "schema": { "title": "networkDevice", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "allOf": [ { "title": "GetQOSSAPEgressPolicy", "required": [ "nokia-conf:sap-egress" ], "type": "object", "properties": { "nokia-conf:sap-egress": { "type": "array", "items": { "title": "NokiaConfSapEgress", "required": [ "sap-egress-policy-name", "description", "policy-id", "fc", "queue" ], "type": "object", "properties": { "sap-egress-policy-name": { "type": "string" }, "description": { "type": "string" }, "policy-id": { "type": "integer" }, "fc": { "type": "array", "items": { "title": "Fc", "required": [ "fc-name", "queue" ], "type": "object", "properties": { "fc-name": { "type": "string" }, "queue": { "type": "integer" } }, "example": { "fc-name": "be", "queue": 1 } }, "description": "" }, "queue": { "type": "array", "items": { "title": "Queue", "required": [ "queue-id", "rate", "adaptation-rule", "queue-type" ], "type": "object", "properties": { "queue-id": { "type": "integer" }, "rate": { "title": "Rate", "required": [ "pir", "cir" ], "type": "object", "properties": { "pir": { "type": "string" }, "cir": { "type": "string" } }, "example": { "pir": "1000", "cir": "100" } }, "adaptation-rule": { "title": "AdaptationRule", "required": [ "pir", "cir" ], "type": "object", "properties": { "pir": { "type": "string" }, "cir": { "type": "string" } }, "example": { "pir": "max", "cir": "min" } }, "queue-type": { "type": "string" } }, "example": { "queue-id": 1, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "auto-expedited" } }, "description": "" } }, "example": { "sap-egress-policy-name": "Engress5", "description": "Egress QoS 5", "policy-id": 5, "fc": [ { "fc-name": "be", "queue": 1 }, { "fc-name": "l2", "queue": 2 }, { "fc-name": "af", "queue": 3 }, { "fc-name": "l1", "queue": 4 }, { "fc-name": "h2", "queue": 5 }, { "fc-name": "ef", "queue": 6 }, { "fc-name": "h1", "queue": 7 }, { "fc-name": "nc", "queue": 8 } ], "queue": [ { "queue-id": 1, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "auto-expedited" }, { "queue-id": 2, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 3, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 4, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 5, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 6, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 7, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 8, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" } ] } }, "description": "" } }, "example": { "nokia-conf:sap-egress": [ { "sap-egress-policy-name": "Engress5", "description": "Egress QoS 5", "policy-id": 5, "fc": [ { "fc-name": "be", "queue": 1 }, { "fc-name": "l2", "queue": 2 }, { "fc-name": "af", "queue": 3 }, { "fc-name": "l1", "queue": 4 }, { "fc-name": "h2", "queue": 5 }, { "fc-name": "ef", "queue": 6 }, { "fc-name": "h1", "queue": 7 }, { "fc-name": "nc", "queue": 8 } ], "queue": [ { "queue-id": 1, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "auto-expedited" }, { "queue-id": 2, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 3, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 4, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 5, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 6, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 7, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 8, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" } ] } ] } }, { "example": { "nokia-conf:sap-egress": [ { "sap-egress-policy-name": "Engress5", "description": "Egress QoS 5", "policy-id": 5, "fc": [ { "fc-name": "be", "queue": 1 }, { "fc-name": "l2", "queue": 2 }, { "fc-name": "af", "queue": 3 }, { "fc-name": "l1", "queue": 4 }, { "fc-name": "h2", "queue": 5 }, { "fc-name": "ef", "queue": 6 }, { "fc-name": "h1", "queue": 7 }, { "fc-name": "nc", "queue": 8 } ], "queue": [ { "queue-id": 1, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "auto-expedited" }, { "queue-id": 2, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 3, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 4, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 5, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 6, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 7, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" }, { "queue-id": 8, "rate": { "pir": "1000", "cir": "100" }, "adaptation-rule": { "pir": "max", "cir": "min" }, "queue-type": "expedited" } ] } ] } } ] } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getQOSSAPEgressPolicy" }, "task": true }, { "name": "editQOSPolicy", "summary": "Edit QOS Policy", "description": "Edit QOS Policy", "input": [ { "name": "networkDevice", "type": "string", "info": "network device id", "required": true, "schema": { "title": "networkDevice", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "allOf": [ { "type": "object" }, { "example": { "nokia-conf:sap-egress": [ { "sap-egress-policy-name": "Engress6_Test", "description": "Egress QoS 6-Test New", "policy-id": 7 } ] } } ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/editQOSPolicyCopy" }, "task": true } ], "views": [] }