{ "id": "@itentialopensource/adapter-nokia_nsp_nfm_p", "type": "Adapter", "export": "NokiaNSPNFMP", "title": "Nokia_nsp_nfm_p", "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": "getAuthToken", "summary": "Get a Bearer token", "description": "Support for the ‘/nfm-p/rest/api/v1/auth’ API will be available up to NSP 22.11 and removed in NSP 23.03. Please use NSP gateway to authenticate a user and to refresh a token.\n\nSpecifies the authentication interface to be used to get a Bearer token or to refresh a Bearer token.\nFor example, the client makes the following HTTP request:\n\n\n POST /v1/auth HTTP/1.1\n Host: server.example.com\n Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW\n X-FORWARDED-FOR: RestClientAddress (Opti...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "The token type to supply: object", "required": false, "schema": { "type": "object", "additionalProperties": { "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": "/getAuthToken" }, "task": true }, { "name": "restCreateChild", "summary": "Creates a child of an existing object with the desired configuration values for the child or childr", "description": "Returns JSON-formatted data upon successful creation of the object. For example, to create a child object, make the following HTTP request.\n\n POST /v1/managedobjects HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA\n Content-Type: application/json\n {\n \"fdn\": \"pollerManager\",\n \"configInfo\": {\n \"fullClassName\": \"security.MediationPolicy\",\n \"properties\": {\n \"snmpPort\": 161,\n \"securityModel\": \"snmpv3\",\n ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"fdn\": \"string\", \"configInfo\": {\"children\": [{\"children\": \"array\", \"fullClassName\": \"string\", \"properties\": \"object\"}], \"fullClassName\": \"string\", \"properties\": \"object\"}}", "required": false, "schema": { "type": "object", "required": [ "configInfo", "fdn" ], "properties": { "fdn": { "type": "string", "description": "The fully distinguished name of the parent object" }, "configInfo": { "type": "object", "required": [ "fullClassName", "properties" ], "properties": { "children": { "type": "array", "description": "Optional grandchildren to be configured. ex: { \"fullClassName\":\"packageName.className\",\"properties\": {attribute1\": \"value1\",\"attribute2\":\"value2\",\"attributeN\": \"valueN}}", "items": { "type": "object", "required": [ "fullClassName", "properties" ], "properties": { "children": { "type": "array", "description": "Optional grandchildren to be configured. ex: { \"fullClassName\":\"packageName.className\",\"properties\": {attribute1\": \"value1\",\"attribute2\":\"value2\",\"attributeN\": \"valueN}}", "items": { "type": "object" } }, "fullClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "properties": { "type": "object", "description": "The desired values to be configured for the child object. ex: {\"property1\":\"value1\", \"property2\":\"value2\", ..... ,\"propertyN\":\"valueN\"}", "additionalProperties": { "type": "object" } } }, "description": "Model containing the Data model for RestfulConfigurationInfo" } }, "fullClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "properties": { "type": "object", "description": "The desired values to be configured for the child object. ex: {\"property1\":\"value1\", \"property2\":\"value2\", ..... ,\"propertyN\":\"valueN\"}", "additionalProperties": { "type": "object" } } }, "description": "Model containing the Data model for RestfulConfigurationInfo" } }, "description": "Model containing the Data model for RestfulConfigurationContainer" } } ], "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": "/restCreateChild" }, "task": true }, { "name": "findWithChildren", "summary": "Find all children of the object by FDN", "description": "Returns a JSON-formatted response for this FDN and all children specified by the fullClassNameList. For example, the client makes the following HTTP request:\n\n\n POST /v1/managedobjects/children HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n {\"fdn\":\"securityManager\", \"fullClassNameList\":[\"security.User\",\"security.UserGroup\"]}\n\n\n Note: Support for the ‘/nfm-p/rest/api/v1’ API will...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "The desired FDN and the children class names: {\"fdn\": \"string\", \"fullClassNameList\": \"array\"}", "required": false, "schema": { "type": "object", "properties": { "fdn": { "type": "string" }, "fullClassNameList": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing a NFM-P FDN as a string and a list of children class name, Example: {'fdn':'securityManager', 'fullClassNameList:['security.User','security.Group']'}" } } ], "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": "/findWithChildren" }, "task": true }, { "name": "queryForClassesWithFilter", "summary": "Find a list of managed objects", "description": "Returns a JSON-formatted response representing the object identified by this fullClassNameList and simpleAttributeAndFilter.\n For example, the client makes the following HTTP request:\n\n POST /v1/managedobjects/search HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n { \"fullClassName\": \"security.User\", \"simpleAttributeAndFilter\": { \"userName\":\"admin\"} }\n\n Note : Filter is optional. If filt...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Configured parameter values of the object for which to search.: {\"fullClassName\": \"string\", \"simpleAttributeAndFilter\": \"object\"}", "required": true, "schema": { "type": "object", "required": [ "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "String", "description": "ex: packageName.className " }, "simpleAttributeAndFilter": { "type": "object", "description": "ex: {\"attribute1\":\"value1\",\"attribute2\":\"value2\"}", "additionalProperties": { "type": "string" } } }, "description": "Model containing the Data model to search for classes" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/queryForClassesWithFilter" }, "task": true }, { "name": "queryForClassesWithRestFilter", "summary": "Find a list of managed objects", "description": "Returns a JSON-formatted response representing the object identified by this fullClass, filterExpression and resultFilter.\n For example, the client makes the following HTTP request:\n\n POST /v1/managedobjects/searchWithFilter HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n {\n \"fullClassName\": \"security.UserGroup\",\n \"resultFilter\":[\"name\",\"spanOfControlProfileName\",\"descriptio...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Configured parameter values of the object for which to search.: {\"resultFilter\": \"array\", \"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": true, "schema": { "type": "object", "required": [ "fullClassName" ], "properties": { "resultFilter": { "type": "array", "description": "string", "items": { "type": "string" } }, "fullClassName": { "type": "string", "example": "security.UserGroup", "description": "string" }, "filterExpression": { "type": "string", "example": "groupName='admin' OR scopeOfCommandProfileName='admin'", "description": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/queryForClassesWithRestFilter" }, "task": true }, { "name": "produceJSON", "summary": "Find the NFM-P managed Object by FDN", "description": "Returns a JSON-formatted response for a given managed object. For example, to find an object using NFM-P's FDN , make the following HTTP request:\n\n GET /v1/managedobjects/securityManager HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA\n Content-Type: application/json\n\n\n The NFM-P server returns JSON-formatted data for the requested FDN .\n\n Note : Client applications using this endpoint should apply html encoding twice to the FDN path parameter...(description truncated)", "input": [ { "name": "fdn", "type": "string", "info": "FDN of the NFM-P managed object for which to search.: string", "required": true, "schema": { "title": "fdn", "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": "/produceJSON" }, "task": true }, { "name": "restModify", "summary": "Modify an existing object.", "description": "This method returns the newly-configured parameters of the object. For example, the client makes the following HTTP request:\n POST /v1/managedobjects/pollerManager%3Amediation-security-2 HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA\n Content-Type: application/json\n\n {\n \"fullClassName\": \"security.MediationPolicy\",\n \"properties\": {\n \"snmpPort\": 161,\n \"securityModel\": \"snmpv3\",\n \"displayedName\": \"SnmpV3 - fo...(description truncated)", "input": [ { "name": "fdn", "type": "string", "info": ": string", "required": true, "schema": { "title": "fdn", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"children\": [{\"children\": \"array\", \"fullClassName\": \"string\", \"properties\": \"object\"}], \"fullClassName\": \"string\", \"properties\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "fullClassName", "properties" ], "properties": { "children": { "type": "array", "description": "Optional grandchildren to be configured. ex: { \"fullClassName\":\"packageName.className\",\"properties\": {attribute1\": \"value1\",\"attribute2\":\"value2\",\"attributeN\": \"valueN}}", "items": { "type": "object", "required": [ "fullClassName", "properties" ], "properties": { "children": { "type": "array", "description": "Optional grandchildren to be configured. ex: { \"fullClassName\":\"packageName.className\",\"properties\": {attribute1\": \"value1\",\"attribute2\":\"value2\",\"attributeN\": \"valueN}}", "items": { "type": "object" } }, "fullClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "properties": { "type": "object", "description": "The desired values to be configured for the child object. ex: {\"property1\":\"value1\", \"property2\":\"value2\", ..... ,\"propertyN\":\"valueN\"}", "additionalProperties": { "type": "object" } } }, "description": "Model containing the Data model for RestfulConfigurationInfo" } }, "fullClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "properties": { "type": "object", "description": "The desired values to be configured for the child object. ex: {\"property1\":\"value1\", \"property2\":\"value2\", ..... ,\"propertyN\":\"valueN\"}", "additionalProperties": { "type": "object" } } }, "description": "Model containing the Data model for RestfulConfigurationInfo" } } ], "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": "/restModify" }, "task": true }, { "name": "restGenericObjectDeleteInstance", "summary": "Remove an existing object", "description": "This method does not return any data on successful deletion of an object. For example, to delete an object using NFM-P's FDN , make the following HTTP request.\n\n DELETE /v1/managedobjects/pollerManager%253Amediation-security-8 HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA\n Content-Type: application/json\n\n\n\n\n Note : Client applications using this endpoint should apply html encoding twice to the FDN path parameter.\nSupport for the ‘/nfm-p/rest...(description truncated)", "input": [ { "name": "fdn", "type": "string", "info": ": string", "required": true, "schema": { "title": "fdn", "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": "/restGenericObjectDeleteInstance" }, "task": true }, { "name": "postV1ManagedobjectsFdnChildren", "summary": "Find all children of the object by FDN", "description": "Returns a JSON-formatted response for this FDN and all children specified by the array of childClassName and resultFilter list. For example, the client makes the following HTTP request:\n\n\n POST /v1/managedobjects/securityManager/children HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n [ {\"childClassName\":\"security.UserGroup\", \"resultFilter\":[\"name\",\"scopeOfCommandProfileName\"]} ]\n\n\n...(description truncated)", "input": [ { "name": "fdn", "type": "string", "info": "The desired FDN and the children class names: string", "required": true, "schema": { "title": "fdn", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/postV1ManagedobjectsFdnChildren" }, "task": true }, { "name": "revokeToken", "summary": "Revoke a Bearer token", "description": "This endpoint is deprecated. Please use NSP gateway to revoke a token.\n\nTo revoke your token, make the following HTTP request:\n\n POST /v1/revoke HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA\n Content-Type: application/json\n\n {\"revoke_type\":\"token\", \"username\":\"my_username\"}\n\n An example of a successful response:\n\n HTTP/1.1 200 OK\n Content-Type: application/json;charset=UTF-8\n Cache-Control: no-cache\n\n {\n }\n The author...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "The revoke parameters: object", "required": false, "schema": { "type": "object", "additionalProperties": { "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": "/revokeToken" }, "task": true }, { "name": "restAaaIsaRadiusPolicyRemovePassword", "summary": "rest_aaa_IsaRadiusPolicy_removePassword", "description": "rest_aaa_IsaRadiusPolicy_removePassword", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restAaaIsaRadiusPolicyRemovePassword" }, "task": true }, { "name": "restAaaIsaRadiusServerClearSecret", "summary": "rest_aaa_IsaRadiusServer_clearSecret", "description": "rest_aaa_IsaRadiusServer_clearSecret", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restAaaIsaRadiusServerClearSecret" }, "task": true }, { "name": "restAaaRadiusProxyServerClearSecret", "summary": "rest_aaa_RadiusProxyServer_clearSecret", "description": "rest_aaa_RadiusProxyServer_clearSecret", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restAaaRadiusProxyServerClearSecret" }, "task": true }, { "name": "restAaaRadiusServerPolicyClearSecret", "summary": "rest_aaa_RadiusServerPolicy_clearSecret", "description": "rest_aaa_RadiusServerPolicy_clearSecret", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restAaaRadiusServerPolicyClearSecret" }, "task": true }, { "name": "restAaaRadiusServerPolicyRequestClearMessageBuffer", "summary": "requestClearMessageBuffer", "description": "Intention : MODIFIER requestClearMessageBuffer: instance-level modifier API requestClearMessageBuffer of class aaa.RadiusServerPolicy instanceFullName : distinguished/instance name of called object A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restAaaRadiusServerPolicyRequestClearMessageBuffer" }, "task": true }, { "name": "restAaaRouteDownloadPolicyForceDownload", "summary": "rest_aaa_RouteDownloadPolicy_forceDownload", "description": "rest_aaa_RouteDownloadPolicy_forceDownload", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restAaaRouteDownloadPolicyForceDownload" }, "task": true }, { "name": "restAapolicyAAGroupPolicyDeleteAllSystemResidentialDCPGroups", "summary": "rest_aapolicy_AAGroupPolicy_DeleteAllSystemResidentialDCPGroups", "description": "rest_aapolicy_AAGroupPolicy_DeleteAllSystemResidentialDCPGroups", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restAapolicyAAGroupPolicyDeleteAllSystemResidentialDCPGroups" }, "task": true }, { "name": "restAapolicyAAUrlFilterResyncToUpdateOperStatus", "summary": "rest_aapolicy_AAUrlFilter_resyncToUpdateOperStatus", "description": "rest_aapolicy_AAUrlFilter_resyncToUpdateOperStatus", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"groupId\": 123, \"urlFilterName\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "groupId", "siteId", "urlFilterName" ], "properties": { "siteId": { "type": "string", "description": " Network Element site IP address." }, "groupId": { "type": "integer", "description": " The ISA-AA Group Index." }, "urlFilterName": { "type": "string", "description": " AA URL Filter name." } }, "description": "Model containing the method level model for AAUrlFilter.resyncToUpdateOperStatus to decode json data to internal NFM-P object model" } } ], "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": "/restAapolicyAAUrlFilterResyncToUpdateOperStatus" }, "task": true }, { "name": "restAapolicyAAUrlListPolicyRemoveDecryptKey", "summary": "rest_aapolicy_AAUrlListPolicy_removeDecryptKey", "description": "rest_aapolicy_AAUrlListPolicy_removeDecryptKey", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restAapolicyAAUrlListPolicyRemoveDecryptKey" }, "task": true }, { "name": "restAapolicyAAUrlListPolicyRetrieveAAUrlListStatus", "summary": "retrieveAAUrlListStatus", "description": "Method to retrieve AAUrlListStatus. Intention : RETRIEVER retrieveAAUrlListStatus: class-level retriever API retrieveAAUrlListStatus of class aapolicy.AAUrlListPolicy", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"groupId\": 123, \"urlListName\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "groupId", "siteId", "urlListName" ], "properties": { "siteId": { "type": "string", "description": " Network Element site IP address." }, "groupId": { "type": "integer", "description": " The ISA-AA Group Partition Index." }, "urlListName": { "type": "string", "description": " AA URL List name." } }, "description": "Model containing the method level model for AAUrlListPolicy.retrieveAAUrlListStatus to decode json data to internal NFM-P object model" } } ], "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": "/restAapolicyAAUrlListPolicyRetrieveAAUrlListStatus" }, "task": true }, { "name": "restAapolicyApplicationFilterRenumId", "summary": "rest_aapolicy_ApplicationFilter_renumId", "description": "rest_aapolicy_ApplicationFilter_renumId", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInAaGroupId\": 123, \"aInAaPartId\": 123, \"aInOldId\": 123, \"aInNewId\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInAaGroupId": { "type": "integer" }, "aInAaPartId": { "type": "integer" }, "aInOldId": { "type": "integer" }, "aInNewId": { "type": "integer" } }, "description": "Model containing the method level model for ApplicationFilter.renumId to decode json data to internal NFM-P object model" } } ], "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": "/restAapolicyApplicationFilterRenumId" }, "task": true }, { "name": "restAapolicyApplicationFilterRenumIds", "summary": "rest_aapolicy_ApplicationFilter_renumIds", "description": "rest_aapolicy_ApplicationFilter_renumIds", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInAaGroupId\": 123, \"aInAaPartId\": 123, \"aInStartId\": 123, \"aInEndId\": 123, \"aInFactor\": \"string\", \"aInFactorValue\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInAaGroupId": { "type": "integer" }, "aInAaPartId": { "type": "integer" }, "aInStartId": { "type": "integer" }, "aInEndId": { "type": "integer" }, "aInFactor": { "type": "string" }, "aInFactorValue": { "type": "integer" } }, "description": "Model containing the method level model for ApplicationFilter.renumIds to decode json data to internal NFM-P object model" } } ], "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": "/restAapolicyApplicationFilterRenumIds" }, "task": true }, { "name": "restAapolicyDbInfoTransitIpAddressRetrieveDbInfoTransitIpAddress", "summary": "retrieveDbInfoTransitIpAddress", "description": "Method to retrieve DbInfoTransitIpAddress. Intention : RETRIEVER retrieveDbInfoTransitIpAddress: class-level retriever API retrieveDbInfoTransitIpAddress of class aapolicy.DbInfoTransitIpAddress", "input": [ { "name": "body", "type": "object", "info": ": {\"timeout\": 123, \"siteId\": \"string\", \"isaGrpPartIndex\": 123, \"transitPlcyId\": 123, \"subName\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "isaGrpPartIndex", "siteId", "subName", "timeout", "transitPlcyId" ], "properties": { "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If the results arenot received in the given time, the method returns." }, "siteId": { "type": "string", "description": " Network Element site IP address." }, "isaGrpPartIndex": { "type": "integer", "description": " The ISA-AA Group Partition Index." }, "transitPlcyId": { "type": "integer", "description": " Transit policy Id." }, "subName": { "type": "string", "description": " Transit subscriber name." } }, "description": "Model containing the method level model for DbInfoTransitIpAddress.retrieveDbInfoTransitIpAddress to decode json data to internal NFM-P object model" } } ], "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": "/restAapolicyDbInfoTransitIpAddressRetrieveDbInfoTransitIpAddress" }, "task": true }, { "name": "restAapolicyDbInfoTransitPrefixAddressRetrieveDbInfoTransitPrefixAddress", "summary": "retrieveDbInfoTransitPrefixAddress", "description": "Method to retrieve DbInfoTransitPrefixAddress. Intention : RETRIEVER retrieveDbInfoTransitPrefixAddress: class-level retriever API retrieveDbInfoTransitPrefixAddress of class aapolicy.DbInfoTransitPrefixAddress", "input": [ { "name": "body", "type": "object", "info": ": {\"timeout\": 123, \"siteId\": \"string\", \"isaGrpPartIndex\": 123, \"transitPlcyId\": 123, \"subName\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "isaGrpPartIndex", "siteId", "subName", "timeout", "transitPlcyId" ], "properties": { "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If the results arenot received in the given time, the method returns." }, "siteId": { "type": "string", "description": " Network Element site IP address." }, "isaGrpPartIndex": { "type": "integer", "description": " The ISA-AA Group Partition Index." }, "transitPlcyId": { "type": "integer", "description": " Transit policy Id." }, "subName": { "type": "string", "description": " Transit subscriber name." } }, "description": "Model containing the method level model for DbInfoTransitPrefixAddress.retrieveDbInfoTransitPrefixAddress to decode json data to internal NFM-P object model" } } ], "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": "/restAapolicyDbInfoTransitPrefixAddressRetrieveDbInfoTransitPrefixAddress" }, "task": true }, { "name": "restAapolicyDbInfoTransitSubscriberInvokeResyncDbInfoTransitSubscriber", "summary": "rest_aapolicy_DbInfoTransitSubscriber_invokeResyncDbInfoTransitSubscriber", "description": "rest_aapolicy_DbInfoTransitSubscriber_invokeResyncDbInfoTransitSubscriber", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"isaGrpPartIndex\": 123}", "required": false, "schema": { "type": "object", "required": [ "isaGrpPartIndex", "siteId" ], "properties": { "siteId": { "type": "string", "description": " Network Element site IP address." }, "isaGrpPartIndex": { "type": "integer", "description": " The ISA-AA Group Partition Index." } }, "description": "Model containing the method level model for DbInfoTransitSubscriber.invokeResyncDbInfoTransitSubscriber to decode json data to internal NFM-P object model" } } ], "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": "/restAapolicyDbInfoTransitSubscriberInvokeResyncDbInfoTransitSubscriber" }, "task": true }, { "name": "restAapolicyDbInfoTransitSubscriberManagerRetrieveTransitSubscribers", "summary": "retrieveTransitSubscribers", "description": "Method used to retrieve extended Transit Subscriber information from the network. It can include also the information for the children classes as it is requested by invoker. Intention : RETRIEVER retrieveTransitSubscribers: class-level retriever API retrieveTransitSubscribers on default instance tsmgr of class aapolicy.DbInfoTransitSubscriberManager Transit Subscriber info object where only persisted information about Transit Subscriber is set.", "input": [ { "name": "body", "type": "object", "info": ": {\"timeout\": 123, \"dbInfoTransitSubscriberRetrievalInfoList\": [{\"objectClassName\": \"string\", \"siteId\": \"string\", \"isaGrpPartIndex\": 123, \"subName\": \"string\", \"transitIpPlcyId\": 123, \"transitPrefixPlcyId\": 123, \"includeChildren\": \"boolean\"}]}", "required": false, "schema": { "type": "object", "required": [ "dbInfoTransitSubscriberRetrievalInfoList", "timeout" ], "properties": { "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If the results arenot received in the given time, the method returns." }, "dbInfoTransitSubscriberRetrievalInfoList": { "type": "array", "description": " ", "items": { "type": "object", "required": [ "includeChildren", "isaGrpPartIndex", "objectClassName", "siteId", "subName", "transitIpPlcyId", "transitPrefixPlcyId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "isaGrpPartIndex": { "type": "integer" }, "subName": { "type": "string" }, "transitIpPlcyId": { "type": "integer" }, "transitPrefixPlcyId": { "type": "integer" }, "includeChildren": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for struct DbInfoTransitSubscriberRetrievalStruct. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for DbInfoTransitSubscriberManager.retrieveTransitSubscribers to decode json data to internal NFM-P object model" } } ], "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": "/restAapolicyDbInfoTransitSubscriberManagerRetrieveTransitSubscribers" }, "task": true }, { "name": "restAclfilterAbstractFilterDefinitionFindAccessInterfaces", "summary": "findAccessInterfaces", "description": "Intention : RETRIEVER findAccessInterfaces: instance-level [object finder] (retriever) API findAccessInterfaces of class aclfilter.AbstractFilterDefinition DescendantInfo: aclfilter.FilterDefinition DescendantInfo: aclfilter.MacFilter DescendantInfo: aclfilter.VlanFilter DescendantInfo: aclfilter.IpFilter DescendantInfo: aclfilter.AggregateFilter DescendantInfo: aclfilter.Ipv6Filter instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restAclfilterAbstractFilterDefinitionFindAccessInterfaces" }, "task": true }, { "name": "restAclfilterAbstractFilterDefinitionFindCircuits", "summary": "findCircuits", "description": "Intention : RETRIEVER findCircuits: instance-level [object finder] (retriever) API findCircuits of class aclfilter.AbstractFilterDefinition DescendantInfo: aclfilter.FilterDefinition DescendantInfo: aclfilter.MacFilter DescendantInfo: aclfilter.VlanFilter DescendantInfo: aclfilter.IpFilter DescendantInfo: aclfilter.AggregateFilter DescendantInfo: aclfilter.Ipv6Filter instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restAclfilterAbstractFilterDefinitionFindCircuits" }, "task": true }, { "name": "restAclfilterAbstractFilterDefinitionFindNetworkIpInterfaces", "summary": "findNetworkIpInterfaces", "description": "Intention : RETRIEVER findNetworkIpInterfaces: instance-level [object finder] (retriever) API findNetworkIpInterfaces of class aclfilter.AbstractFilterDefinition DescendantInfo: aclfilter.FilterDefinition DescendantInfo: aclfilter.MacFilter DescendantInfo: aclfilter.VlanFilter DescendantInfo: aclfilter.IpFilter DescendantInfo: aclfilter.AggregateFilter DescendantInfo: aclfilter.Ipv6Filter instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restAclfilterAbstractFilterDefinitionFindNetworkIpInterfaces" }, "task": true }, { "name": "restAclfilterDhcpFilterGetAllGroupInterfaces", "summary": "getAllGroupInterfaces", "description": "Intention : RETRIEVER getAllGroupInterfaces: instance-level retriever API getAllGroupInterfaces of class aclfilter.DhcpFilter instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restAclfilterDhcpFilterGetAllGroupInterfaces" }, "task": true }, { "name": "restAclfilterEntryDefinitionFind", "summary": "find", "description": "Intention : RETRIEVER find: class-level [object finder] (retriever) API find of class aclfilter.EntryDefinition DescendantInfo: aclfilter.VlanFilterEntry DescendantInfo: aclfilter.AppEntryDefinition DescendantInfo: aclfilter.Ipv6FilterEntry DescendantInfo: aclfilter.MacFilterEntry DescendantInfo: aclfilter.ApplicationIPFilterEntry DescendantInfo: aclfilter.CommonEntryDefinition DescendantInfo: aclfilter.ApplicationIPv6FilterEntry DescendantInfo: aclfilter.IpFilterEntry", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restAclfilterEntryDefinitionFind" }, "task": true }, { "name": "restAclfilterEntryDefinitionRenum", "summary": "rest_aclfilter_EntryDefinition_renum", "description": "rest_aclfilter_EntryDefinition_renum", "input": [ { "name": "body", "type": "object", "info": ": {\"aInNewEntryFullName\": \"string\", \"aInOldEntryFullName\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInNewEntryFullName": { "type": "string" }, "aInOldEntryFullName": { "type": "string" } }, "description": "Model containing the method level model for SecurityPolicyEntryDefinition.renum to decode json data to internal NFM-P object model" } } ], "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": "/restAclfilterEntryDefinitionRenum" }, "task": true }, { "name": "restAclfilterFilterDefinitionFindEgressMcastGroups", "summary": "findEgressMcastGroups", "description": "Intention : RETRIEVER findEgressMcastGroups: instance-level [object finder] (retriever) API findEgressMcastGroups of class aclfilter.FilterDefinition DescendantInfo: aclfilter.MacFilter DescendantInfo: aclfilter.VlanFilter DescendantInfo: aclfilter.IpFilter DescendantInfo: aclfilter.Ipv6Filter instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restAclfilterFilterDefinitionFindEgressMcastGroups" }, "task": true }, { "name": "restAclfilterFilterDefinitionFindServiceIpInterfaces", "summary": "findServiceIpInterfaces", "description": "Intention : RETRIEVER findServiceIpInterfaces: instance-level [object finder] (retriever) API findServiceIpInterfaces of class aclfilter.FilterDefinition DescendantInfo: aclfilter.MacFilter DescendantInfo: aclfilter.VlanFilter DescendantInfo: aclfilter.IpFilter DescendantInfo: aclfilter.Ipv6Filter instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restAclfilterFilterDefinitionFindServiceIpInterfaces" }, "task": true }, { "name": "restAclfilterFilterDefinitionInitiateGroupInserts", "summary": "initiateGroupInserts", "description": "Method used by IPFilter and IPv6Filter for group insertion sorting. Method invocation will be ignored for any other filter types. Intention : MODIFIER initiateGroupInserts: class-level modifier API initiateGroupInserts of class aclfilter.FilterDefinition DescendantInfo: aclfilter.MacFilter DescendantInfo: aclfilter.VlanFilter DescendantInfo: aclfilter.IpFilter DescendantInfo: aclfilter.Ipv6Filter", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"filterType\": \"string\", \"applicationType\": \"string\", \"entryLocation\": \"string\", \"siteId\": \"string\", \"filterId\": 123}", "required": false, "schema": { "type": "object", "required": [ "applicationType", "entryLocation", "filterId", "filterType", "objectClassName", "siteId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "filterType": { "type": "string" }, "applicationType": { "type": "string" }, "entryLocation": { "type": "string" }, "siteId": { "type": "string" }, "filterId": { "type": "integer" } }, "description": "Model containing the method level model for struct GroupEntriesStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restAclfilterFilterDefinitionInitiateGroupInserts" }, "task": true }, { "name": "restAclfilterFilterDefinitionRetrieveHostSharedFilter", "summary": "retrieveHostSharedFilter", "description": "Method retrieves IP Filter and IPv6 Filter from the network element. This method has option to specify either retrieving its entries or not. Intention : RETRIEVER retrieveHostSharedFilter: class-level retriever API retrieveHostSharedFilter of class aclfilter.FilterDefinition DescendantInfo: aclfilter.MacFilter DescendantInfo: aclfilter.VlanFilter DescendantInfo: aclfilter.IpFilter DescendantInfo: aclfilter.Ipv6Filter", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"filterType\": \"string\", \"retrieveEntryOption\": \"string\", \"entryApplicationType\": \"string\", \"siteId\": \"string\", \"filterId\": 123}", "required": false, "schema": { "type": "object", "required": [ "entryApplicationType", "filterId", "filterType", "objectClassName", "retrieveEntryOption", "siteId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "filterType": { "type": "string" }, "retrieveEntryOption": { "type": "string" }, "entryApplicationType": { "type": "string" }, "siteId": { "type": "string" }, "filterId": { "type": "integer" } }, "description": "Model containing the method level model for struct RtrvHostSharedFilterStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restAclfilterFilterDefinitionRetrieveHostSharedFilter" }, "task": true }, { "name": "restAclfilterIpFilterEntryFindSampleProfile", "summary": "findSampleProfile", "description": "Intention : RETRIEVER findSampleProfile: class-level [object finder] (retriever) API findSampleProfile of class aclfilter.IpFilterEntry", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restAclfilterIpFilterEntryFindSampleProfile" }, "task": true }, { "name": "restAclfilterIpv6FilterEntryFindSampleProfile", "summary": "findSampleProfile", "description": "Intention : RETRIEVER findSampleProfile: class-level [object finder] (retriever) API findSampleProfile of class aclfilter.Ipv6FilterEntry", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restAclfilterIpv6FilterEntryFindSampleProfile" }, "task": true }, { "name": "restActivationAbstractWorkOrderRetrieveWorkOrderXML", "summary": "retrieveWorkOrderXML", "description": "Get the work order as XML. Intention : RETRIEVER retrieveWorkOrderXML: instance-level retriever API retrieveWorkOrderXML of class activation.AbstractWorkOrder DescendantInfo: activation.WorkOrder DescendantInfo: activation.NeWorkOrder instanceFullName : distinguished/instance name of called object The work order.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restActivationAbstractWorkOrderRetrieveWorkOrderXML" }, "task": true }, { "name": "restActivationActivationManagerFindWithWorkOrderScan", "summary": "findWithWorkOrderScan", "description": "Intention : RETRIEVER findWithWorkOrderScan: class-level [object finder] (retriever) API findWithWorkOrderScan on default instance actv-mgr of class activation.ActivationManager Result object of shallow map of distinguished name into object summary structure and paging information", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"joinConditions\": [{\"fullClassName\": \"string\", \"filterExpression\": \"string\"}], \"capabillities\": \"array\", \"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123, \"excludedSubClasses\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "capabillities", "excludedSubClasses", "fields", "filter", "fullClassName", "joinConditions", "pageNumber", "pageSize", "sortFields" ], "properties": { "fullClassName": { "type": "string", "description": " Package qualified class name in dot separated format. EXAMPLE:service.Service,rtr.NetworkInterface" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "joinConditions": { "type": "array", "description": " Joins fields of two classes together.For use with Filter.setFilterClass.", "uniqueItems": true, "items": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "capabillities": { "type": "array", "description": " capability id(s).", "uniqueItems": true, "items": { "type": "integer" } }, "fields": { "type": "array", "description": " table fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " page number" }, "pageSize": { "type": "integer", "description": " page size" }, "excludedSubClasses": { "type": "array", "description": " excluded subclasses", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for ActivationManager.findWithWorkOrderScan to decode json data to internal NFM-P object model" } } ], "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": "/restActivationActivationManagerFindWithWorkOrderScan" }, "task": true }, { "name": "restActivationActivationManagerScanWorkOrderRepository", "summary": "rest_activation_ActivationManager_scanWorkOrderRepository", "description": "rest_activation_ActivationManager_scanWorkOrderRepository", "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": "/restActivationActivationManagerScanWorkOrderRepository" }, "task": true }, { "name": "restActivationSessionActivate", "summary": "rest_activation_Session_activate", "description": "rest_activation_Session_activate", "input": [ { "name": "body", "type": "object", "info": ": {\"sessionFdn\": \"string\", \"neWorkOrders\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "neWorkOrders", "sessionFdn" ], "properties": { "sessionFdn": { "type": "string", "description": " The session to validate." }, "neWorkOrders": { "type": "array", "description": " The set of NE work orders to validate. The NE work orders must be in the given session.", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for Session.activate to decode json data to internal NFM-P object model" } } ], "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": "/restActivationSessionActivate" }, "task": true }, { "name": "restActivationSessionActivateAll", "summary": "rest_activation_Session_activateAll", "description": "rest_activation_Session_activateAll", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restActivationSessionActivateAll" }, "task": true }, { "name": "restActivationSessionAddNeWorkOrders", "summary": "addNeWorkOrders", "description": "Adds the NE work orders to the session. Intention : MODIFIER addNeWorkOrders: class-level modifier API addNeWorkOrders of class activation.Session The set of NE work orders that failed to be added to session.", "input": [ { "name": "body", "type": "object", "info": ": {\"sessionFdn\": \"string\", \"neWorkOrders\": \"array\", \"failAllOnError\": \"boolean\", \"autoLoad\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "autoLoad", "failAllOnError", "neWorkOrders", "sessionFdn" ], "properties": { "sessionFdn": { "type": "string", "description": " The session to validate." }, "neWorkOrders": { "type": "array", "description": " The set of NE work orders to add to the session.", "uniqueItems": true, "items": { "type": "string" } }, "failAllOnError": { "type": "boolean", "description": " If set to true, it indicates that the complete operation will fail if any of the given NEwork orders cannot be added to the session. If set to false, the failed NE work orders will be skippedand valid ones will be added.", "default": false }, "autoLoad": { "type": "boolean", "description": " Set if the NE work order contents should automatically be loaded in memory and analyzed.", "default": false } }, "description": "Model containing the method level model for Session.addNeWorkOrders to decode json data to internal NFM-P object model" } } ], "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": "/restActivationSessionAddNeWorkOrders" }, "task": true }, { "name": "restActivationSessionAddWorkOrder", "summary": "addWorkOrder", "description": "Adds all NE work orders contained in the work order to the session. Intention : MODIFIER addWorkOrder: class-level modifier API addWorkOrder of class activation.Session The set of NE work orders that failed to be added to session.", "input": [ { "name": "body", "type": "object", "info": ": {\"sessionFdn\": \"string\", \"workOrderFdn\": \"string\", \"failAllOnError\": \"boolean\", \"autoLoad\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "autoLoad", "failAllOnError", "sessionFdn", "workOrderFdn" ], "properties": { "sessionFdn": { "type": "string", "description": " The session to add work orders to." }, "workOrderFdn": { "type": "string", "description": " The work order to add to the session." }, "failAllOnError": { "type": "boolean", "description": " If set to true, it indicates that the complete operation will fail if any of the given NEwork orders contained in the work order cannot be added to the session. If set to false,the failed NE work orders will be skipped and valid ones will be added.", "default": false }, "autoLoad": { "type": "boolean", "description": " Set if the NE work order contents should automatically be loaded in memory and analyzed.", "default": false } }, "description": "Model containing the method level model for Session.addWorkOrder to decode json data to internal NFM-P object model" } } ], "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": "/restActivationSessionAddWorkOrder" }, "task": true }, { "name": "restActivationSessionCloseSession", "summary": "rest_activation_Session_closeSession", "description": "rest_activation_Session_closeSession", "input": [ { "name": "body", "type": "object", "info": ": {\"sessionFdn\": \"string\", \"shouldDelete\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "sessionFdn", "shouldDelete" ], "properties": { "sessionFdn": { "type": "string", "description": " The session to start." }, "shouldDelete": { "type": "boolean", "description": " If true, the closed session is deleted. If false, the session is not deleted.", "default": false } }, "description": "Model containing the method level model for Session.closeSession to decode json data to internal NFM-P object model" } } ], "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": "/restActivationSessionCloseSession" }, "task": true }, { "name": "restActivationSessionFallback", "summary": "rest_activation_Session_fallback", "description": "rest_activation_Session_fallback", "input": [ { "name": "body", "type": "object", "info": ": {\"sessionFdn\": \"string\", \"neWorkOrders\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "neWorkOrders", "sessionFdn" ], "properties": { "sessionFdn": { "type": "string", "description": " The session." }, "neWorkOrders": { "type": "array", "description": " The set of NE work orders to fallback. The NE work orders must be in the given session.", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for Session.fallback to decode json data to internal NFM-P object model" } } ], "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": "/restActivationSessionFallback" }, "task": true }, { "name": "restActivationSessionLoad", "summary": "rest_activation_Session_load", "description": "rest_activation_Session_load", "input": [ { "name": "body", "type": "object", "info": ": {\"sessionFdn\": \"string\", \"neWorkOrders\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "neWorkOrders", "sessionFdn" ], "properties": { "sessionFdn": { "type": "string", "description": " The session to validate." }, "neWorkOrders": { "type": "array", "description": " The set of NE work orders to load. The NE work orders must be in the given session.", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for Session.load to decode json data to internal NFM-P object model" } } ], "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": "/restActivationSessionLoad" }, "task": true }, { "name": "restActivationSessionLoadAll", "summary": "rest_activation_Session_loadAll", "description": "rest_activation_Session_loadAll", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restActivationSessionLoadAll" }, "task": true }, { "name": "restActivationSessionPreactivate", "summary": "rest_activation_Session_preactivate", "description": "rest_activation_Session_preactivate", "input": [ { "name": "body", "type": "object", "info": ": {\"sessionFdn\": \"string\", \"neWorkOrders\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "neWorkOrders", "sessionFdn" ], "properties": { "sessionFdn": { "type": "string", "description": " The session to validate." }, "neWorkOrders": { "type": "array", "description": " The set of NE work orders to validate. The NE work orders must be in the given session.", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for Session.preactivate to decode json data to internal NFM-P object model" } } ], "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": "/restActivationSessionPreactivate" }, "task": true }, { "name": "restActivationSessionPreactivateAll", "summary": "rest_activation_Session_preactivateAll", "description": "rest_activation_Session_preactivateAll", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restActivationSessionPreactivateAll" }, "task": true }, { "name": "restActivationSessionRelease", "summary": "rest_activation_Session_release", "description": "rest_activation_Session_release", "input": [ { "name": "body", "type": "object", "info": ": {\"sessionFdn\": \"string\", \"neWorkOrders\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "neWorkOrders", "sessionFdn" ], "properties": { "sessionFdn": { "type": "string", "description": " The session." }, "neWorkOrders": { "type": "array", "description": " The set of NE work orders to release. The NE work orders must be in the given session.", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for Session.release to decode json data to internal NFM-P object model" } } ], "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": "/restActivationSessionRelease" }, "task": true }, { "name": "restActivationSessionRemoveNeWorkOrders", "summary": "rest_activation_Session_removeNeWorkOrders", "description": "rest_activation_Session_removeNeWorkOrders", "input": [ { "name": "body", "type": "object", "info": ": {\"sessionFdn\": \"string\", \"neWorkOrders\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "neWorkOrders", "sessionFdn" ], "properties": { "sessionFdn": { "type": "string", "description": " The session to validate." }, "neWorkOrders": { "type": "array", "description": " The set of NE work orders to remove from the session.", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for Session.removeNeWorkOrders to decode json data to internal NFM-P object model" } } ], "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": "/restActivationSessionRemoveNeWorkOrders" }, "task": true }, { "name": "restActivationSessionStartSession", "summary": "rest_activation_Session_startSession", "description": "rest_activation_Session_startSession", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restActivationSessionStartSession" }, "task": true }, { "name": "restActivationSessionUpdateAutoRelease", "summary": "rest_activation_Session_updateAutoRelease", "description": "rest_activation_Session_updateAutoRelease", "input": [ { "name": "body", "type": "object", "info": ": {\"sessionFdn\": \"string\", \"autoRelease\": \"boolean\", \"neWorkOrders\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "autoRelease", "neWorkOrders", "sessionFdn" ], "properties": { "sessionFdn": { "type": "string", "description": " The session." }, "autoRelease": { "type": "boolean", "description": " True to auto release; false to keep in session", "default": false }, "neWorkOrders": { "type": "array", "description": " The set of NE work orders to auto-release. The NE work orders must be in the given session.", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for Session.updateAutoRelease to decode json data to internal NFM-P object model" } } ], "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": "/restActivationSessionUpdateAutoRelease" }, "task": true }, { "name": "restActivationSessionUpdateExclude", "summary": "rest_activation_Session_updateExclude", "description": "rest_activation_Session_updateExclude", "input": [ { "name": "body", "type": "object", "info": ": {\"sessionFdn\": \"string\", \"excluded\": \"boolean\", \"neWorkOrders\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "excluded", "neWorkOrders", "sessionFdn" ], "properties": { "sessionFdn": { "type": "string", "description": " The session." }, "excluded": { "type": "boolean", "description": " True to exclude; false to include.", "default": false }, "neWorkOrders": { "type": "array", "description": " The set of NE work orders to exclude. The NE work orders must be in the given session.", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for Session.updateExclude to decode json data to internal NFM-P object model" } } ], "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": "/restActivationSessionUpdateExclude" }, "task": true }, { "name": "restActivationSessionUpdateSchedule", "summary": "rest_activation_Session_updateSchedule", "description": "rest_activation_Session_updateSchedule", "input": [ { "name": "body", "type": "object", "info": ": {\"sessionFdn\": \"string\", \"scheduled\": \"boolean\", \"scheduledAt\": 123, \"suspendScheduledSession\": \"boolean\", \"closeScheduledSession\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "closeScheduledSession", "scheduled", "scheduledAt", "sessionFdn", "suspendScheduledSession" ], "properties": { "sessionFdn": { "type": "string", "description": " The session to schedule unschedule" }, "scheduled": { "type": "boolean", "description": " True to schedule; false to un-schedule.", "default": false }, "scheduledAt": { "type": "integer", "description": " Time to schedule. Only interpreted if scheduled is true." }, "suspendScheduledSession": { "type": "boolean", "description": " True to suspend the session to allow other actions on the NE; false to continue to lock the NE and forbid all actions on the NE until the end of the session.", "default": false }, "closeScheduledSession": { "type": "boolean", "description": " True to closed the session at the end of the scheduled session; false to do nothing.", "default": false } }, "description": "Model containing the method level model for Session.updateSchedule to decode json data to internal NFM-P object model" } } ], "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": "/restActivationSessionUpdateSchedule" }, "task": true }, { "name": "restActivationSessionValidateNeWorkOrders", "summary": "rest_activation_Session_validateNeWorkOrders", "description": "rest_activation_Session_validateNeWorkOrders", "input": [ { "name": "body", "type": "object", "info": ": {\"sessionFdn\": \"string\", \"neWorkOrders\": \"array\", \"areEngineeringChecksToBeExecuted\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "areEngineeringChecksToBeExecuted", "neWorkOrders", "sessionFdn" ], "properties": { "sessionFdn": { "type": "string", "description": " The session to validate." }, "neWorkOrders": { "type": "array", "description": " The set of NE work orders to validate. The NE work orders must be in the given session.", "uniqueItems": true, "items": { "type": "string" } }, "areEngineeringChecksToBeExecuted": { "type": "boolean", "description": " This parameter indicates whether the engineering have to be executed or not", "default": false } }, "description": "Model containing the method level model for Session.validateNeWorkOrders to decode json data to internal NFM-P object model" } } ], "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": "/restActivationSessionValidateNeWorkOrders" }, "task": true }, { "name": "restActivationSessionValidateSession", "summary": "rest_activation_Session_validateSession", "description": "rest_activation_Session_validateSession", "input": [ { "name": "body", "type": "object", "info": ": {\"sessionFdn\": \"string\", \"areEngineeringChecksToBeExecuted\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "areEngineeringChecksToBeExecuted", "sessionFdn" ], "properties": { "sessionFdn": { "type": "string", "description": " The session to validate." }, "areEngineeringChecksToBeExecuted": { "type": "boolean", "description": " This parameter indicates whether the engineering have to be executed or not", "default": false } }, "description": "Model containing the method level model for Session.validateSession to decode json data to internal NFM-P object model" } } ], "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": "/restActivationSessionValidateSession" }, "task": true }, { "name": "restActivationSnapshotAbort", "summary": "rest_activation_Snapshot_abort", "description": "rest_activation_Snapshot_abort", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restActivationSnapshotAbort" }, "task": true }, { "name": "restActivationSnapshotAddInclusionFilter", "summary": "addInclusionFilter", "description": "This method adds a filter for monitored objects to this supervision group. Filtered objects' class can't be the class of subclass used by any other inclusion filter in this group. Intention : MODIFIER addInclusionFilter: instance-level modifier API addInclusionFilter of class activation.Snapshot instanceFullName : distinguished/instance name of called object New value of the \"inclusionFilters\" property - FDNs of all inclusion filters in this group.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restActivationSnapshotAddInclusionFilter" }, "task": true }, { "name": "restActivationSnapshotExtract", "summary": "rest_activation_Snapshot_extract", "description": "rest_activation_Snapshot_extract", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restActivationSnapshotExtract" }, "task": true }, { "name": "restActivationSnapshotRemoveInclusionFilter", "summary": "removeInclusionFilter", "description": "This method removes a filter for monitored objects from this supervision group. Intention : MODIFIER removeInclusionFilter: instance-level [administrative deletion] (modifier) API removeInclusionFilter of class activation.Snapshot instanceFullName : distinguished/instance name of called object New value of the \"inclusionFilters\" property - FDNs of all inclusion filters in this group.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restActivationSnapshotRemoveInclusionFilter" }, "task": true }, { "name": "restActivationWorkOrderCreateSession", "summary": "createSession", "description": "Will Create a new Session based on the WorkOrder object we have access to. Intention : MODIFIER createSession: class-level [administrative creation] (modifier) API createSession of class activation.WorkOrder The created Session object.", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restActivationWorkOrderCreateSession" }, "task": true }, { "name": "restAdpDomainAddManagedNodes", "summary": "rest_adp_Domain_addManagedNodes", "description": "rest_adp_Domain_addManagedNodes", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restAdpDomainAddManagedNodes" }, "task": true }, { "name": "restAdpDomainFindManagedNodes", "summary": "findManagedNodes", "description": "d Intention : RETRIEVER findManagedNodes: instance-level [object finder] (retriever) API findManagedNodes of class adp.Domain instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restAdpDomainFindManagedNodes" }, "task": true }, { "name": "restAdpDomainFindVprnService", "summary": "findVprnService", "description": "Method used to query the VPRN Services Based on the HeadNode. Fetch the services that relates to Head nodes (i.e. the count of that service will be >1). Intention : RETRIEVER findVprnService: class-level [object finder] (retriever) API findVprnService of class adp.Domain VPRN Service Objects Based on the headNodes.", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restAdpDomainFindVprnService" }, "task": true }, { "name": "restAdpDomainImportFromXML", "summary": "rest_adp_Domain_importFromXML", "description": "rest_adp_Domain_importFromXML", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"importFileName\": \"string\", \"requestId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "importFileName", "requestId" ], "properties": { "importFileName": { "type": "string", "description": " " }, "requestId": { "type": "string", "description": " " } }, "description": "Model containing the method level model for Domain.importFromXML to decode json data to internal NFM-P object model" } } ], "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": "/restAdpDomainImportFromXML" }, "task": true }, { "name": "restAdpDomainImportSerialNumbersFromXML", "summary": "rest_adp_Domain_importSerialNumbersFromXML", "description": "rest_adp_Domain_importSerialNumbersFromXML", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"importFileName\": \"string\", \"requestId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "importFileName", "requestId" ], "properties": { "importFileName": { "type": "string", "description": " " }, "requestId": { "type": "string", "description": " " } }, "description": "Model containing the method level model for Domain.importSerialNumbersFromXML to decode json data to internal NFM-P object model" } } ], "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": "/restAdpDomainImportSerialNumbersFromXML" }, "task": true }, { "name": "restAengrMatchRenum", "summary": "rest_aengr_Match_renum", "description": "rest_aengr_Match_renum", "input": [ { "name": "body", "type": "object", "info": ": {\"aInNewEntryFullName\": \"string\", \"aInOldEntryFullName\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInNewEntryFullName": { "type": "string" }, "aInOldEntryFullName": { "type": "string" } }, "description": "Model containing the method level model for SecurityPolicyEntryDefinition.renum to decode json data to internal NFM-P object model" } } ], "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": "/restAengrMatchRenum" }, "task": true }, { "name": "restAengrPolicyRetrieveHostSharedPccRuleEgressPolicy", "summary": "retrieveHostSharedPccRuleEgressPolicy", "description": "Method retrieves Host Shared QoS SAP Access Egress Policy from the network element. This method has option to specify either retrieving its entries or not. Intention : RETRIEVER retrieveHostSharedPccRuleEgressPolicy: class-level retriever API retrieveHostSharedPccRuleEgressPolicy of class aengr.Policy", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"policyId\": 123, \"retrieveEntryOption\": \"boolean\", \"startEntry\": 123, \"entryCount\": 123}", "required": false, "schema": { "type": "object", "required": [ "entryCount", "objectClassName", "policyId", "retrieveEntryOption", "siteId", "startEntry" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "policyId": { "type": "integer" }, "retrieveEntryOption": { "type": "boolean", "default": false }, "startEntry": { "type": "integer" }, "entryCount": { "type": "integer" } }, "description": "Model containing the method level model for struct RtrvHostSharedPccRuleEgrPolicyStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restAengrPolicyRetrieveHostSharedPccRuleEgressPolicy" }, "task": true }, { "name": "restAingrMatchRenum", "summary": "rest_aingr_Match_renum", "description": "rest_aingr_Match_renum", "input": [ { "name": "body", "type": "object", "info": ": {\"aInNewEntryFullName\": \"string\", \"aInOldEntryFullName\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInNewEntryFullName": { "type": "string" }, "aInOldEntryFullName": { "type": "string" } }, "description": "Model containing the method level model for SecurityPolicyEntryDefinition.renum to decode json data to internal NFM-P object model" } } ], "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": "/restAingrMatchRenum" }, "task": true }, { "name": "restAingrPolicyRetrieveHostSharedPccRuleIngressPolicy", "summary": "retrieveHostSharedPccRuleIngressPolicy", "description": "Method retrieves QoS SAP Access Ingress Policy from the network element. This method has option to specify either retrieving its entries or not. Intention : RETRIEVER retrieveHostSharedPccRuleIngressPolicy: class-level retriever API retrieveHostSharedPccRuleIngressPolicy of class aingr.Policy", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"policyId\": 123, \"retrieveEntryOption\": \"boolean\", \"startEntry\": 123, \"entryCount\": 123}", "required": false, "schema": { "type": "object", "required": [ "entryCount", "objectClassName", "policyId", "retrieveEntryOption", "siteId", "startEntry" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "policyId": { "type": "integer" }, "retrieveEntryOption": { "type": "boolean", "default": false }, "startEntry": { "type": "integer" }, "entryCount": { "type": "integer" } }, "description": "Model containing the method level model for struct RtrvHostSharedPccRuleIngPolicyStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restAingrPolicyRetrieveHostSharedPccRuleIngressPolicy" }, "task": true }, { "name": "restAnalyticsAnalyticsManagerIsAnalyticalBaseEnabled", "summary": "isAnalyticalBaseEnabled", "description": "Intention : RETRIEVER isAnalyticalBaseEnabled: class-level retriever API isAnalyticalBaseEnabled on default instance AnltMgr of class analytics.AnalyticsManager", "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": "/restAnalyticsAnalyticsManagerIsAnalyticalBaseEnabled" }, "task": true }, { "name": "restAnalyticsAnalyticsManagerIsPremiumPkgEnabled", "summary": "isPremiumPkgEnabled", "description": "Intention : RETRIEVER isPremiumPkgEnabled: class-level retriever API isPremiumPkgEnabled on default instance AnltMgr of class analytics.AnalyticsManager", "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": "/restAnalyticsAnalyticsManagerIsPremiumPkgEnabled" }, "task": true }, { "name": "restAnalyticsAnalyticsManagerPurgeAnalyticReports", "summary": "rest_analytics_AnalyticsManager_purgeAnalyticReports", "description": "rest_analytics_AnalyticsManager_purgeAnalyticReports", "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": "/restAnalyticsAnalyticsManagerPurgeAnalyticReports" }, "task": true }, { "name": "restAncpAncpDslLineInfoRetrieveDslLineInfo", "summary": "retrieveDslLineInfo", "description": "Method used to retrieve ANCP DSL Line Information from NE. Intention : RETRIEVER retrieveDslLineInfo: class-level retriever API retrieveDslLineInfo of class ancp.AncpDslLineInfo", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"ancpString\": \"string\", \"parentFullName\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "ancpString", "objectClassName", "parentFullName", "siteId", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "ancpString": { "type": "string" }, "parentFullName": { "type": "string" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct DslLineInfoRetrievalStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restAncpAncpDslLineInfoRetrieveDslLineInfo" }, "task": true }, { "name": "restAntispoofAntiSpoofingFilterRetrieveAntiSpoofingFilters", "summary": "retrieveAntiSpoofingFilters", "description": "Intention : RETRIEVER retrieveAntiSpoofingFilters: class-level retriever API retrieveAntiSpoofingFilters of class antispoof.AntiSpoofingFilter", "input": [ { "name": "body", "type": "object", "info": ": {\"aInRtrId\": \"string\", \"aInPortPointer\": \"string\", \"aInSvcId\": 123, \"aInPortId\": 123, \"aInInnerEncapValue\": 123, \"aInOuterEncapValue\": 123, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInRtrId": { "type": "string" }, "aInPortPointer": { "type": "string" }, "aInSvcId": { "type": "integer" }, "aInPortId": { "type": "integer" }, "aInInnerEncapValue": { "type": "integer" }, "aInOuterEncapValue": { "type": "integer" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns." } }, "description": "Model containing the method level model for AntiSpoofingFilter.retrieveAntiSpoofingFilters to decode json data to internal NFM-P object model" } } ], "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": "/restAntispoofAntiSpoofingFilterRetrieveAntiSpoofingFilters" }, "task": true }, { "name": "restAosredundancyAOSMultiChassisGroupDeleteAOSMultiChassisGroup", "summary": "rest_aosredundancy_AOSMultiChassisGroup_deleteAOSMultiChassisGroup", "description": "rest_aosredundancy_AOSMultiChassisGroup_deleteAOSMultiChassisGroup", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restAosredundancyAOSMultiChassisGroupDeleteAOSMultiChassisGroup" }, "task": true }, { "name": "restAosredundancyAOSVFLinkGroupDeleteVFLinkGroup", "summary": "rest_aosredundancy_AOSVFLinkGroup_deleteVFLinkGroup", "description": "rest_aosredundancy_AOSVFLinkGroup_deleteVFLinkGroup", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restAosredundancyAOSVFLinkGroupDeleteVFLinkGroup" }, "task": true }, { "name": "restAossasCPETestGroupHeadCancelCPETestGroupExection", "summary": "rest_aossas_CPETestGroupHead_cancelCPETestGroupExection", "description": "rest_aossas_CPETestGroupHead_cancelCPETestGroupExection", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restAossasCPETestGroupHeadCancelCPETestGroupExection" }, "task": true }, { "name": "restAossasCPETestHeadCancelCPETestExection", "summary": "rest_aossas_CPETestHead_cancelCPETestExection", "description": "rest_aossas_CPETestHead_cancelCPETestExection", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restAossasCPETestHeadCancelCPETestExection" }, "task": true }, { "name": "restApsApsChannelGetDependencyCount", "summary": "getDependencyCount", "description": "Intention : RETRIEVER getDependencyCount: instance-level retriever API getDependencyCount of class aps.ApsChannel instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restApsApsChannelGetDependencyCount" }, "task": true }, { "name": "restApsApsGroupFindInstanceChannelPorts", "summary": "findInstanceChannelPorts", "description": "Intention : RETRIEVER findInstanceChannelPorts: instance-level [object finder] (retriever) API findInstanceChannelPorts of class aps.ApsGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restApsApsGroupFindInstanceChannelPorts" }, "task": true }, { "name": "restApsMultiChassisApsGroupContainerFindInstanceApsGroups", "summary": "findInstanceApsGroups", "description": "Intention : RETRIEVER findInstanceApsGroups: instance-level [object finder] (retriever) API findInstanceApsGroups of class aps.MultiChassisApsGroupContainer instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restApsMultiChassisApsGroupContainerFindInstanceApsGroups" }, "task": true }, { "name": "restApsMultiChassisApsGroupContainerGetDependencyCount", "summary": "getDependencyCount", "description": "Intention : RETRIEVER getDependencyCount: instance-level retriever API getDependencyCount of class aps.MultiChassisApsGroupContainer instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restApsMultiChassisApsGroupContainerGetDependencyCount" }, "task": true }, { "name": "restArpArpHostRadiusClassAttributeRetrieveArpHostRadiusClasses", "summary": "retrieveArpHostRadiusClasses", "description": "Method used to query the NE for the ARP Host RADIUS Class Attributes related to the specified ARP Host. Intention : RETRIEVER retrieveArpHostRadiusClasses: class-level retriever API retrieveArpHostRadiusClasses of class arp.ArpHostRadiusClassAttribute", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"serviceId\": 123, \"ipAddressType\": 123, \"ipAddress\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "ipAddress", "ipAddressType", "serviceId", "siteId", "timeout" ], "properties": { "siteId": { "type": "string", "description": " Site ID for the ARP Host." }, "serviceId": { "type": "integer", "description": " Service ID for the ARP Host." }, "ipAddressType": { "type": "integer", "description": " IP address type of the ARP host, 1 for IPv4 or 2 for IPv6.This is an optional input parameter. If not specified, address type is inferredfrom IP address input parameter. default:0" }, "ipAddress": { "type": "string", "description": " The IP address of the ARP host." }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait before receiving the results.This is an optional input parameter. The default value is 5 minutes (300000). default:300000" } }, "description": "Model containing the method level model for ArpHostRadiusClassAttribute.retrieveArpHostRadiusClasses to decode json data to internal NFM-P object model" } } ], "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": "/restArpArpHostRadiusClassAttributeRetrieveArpHostRadiusClasses" }, "task": true }, { "name": "restAssuranceAssuranceEventManagerDeregisterApplication", "summary": "rest_assurance_AssuranceEventManager_deregisterApplication", "description": "rest_assurance_AssuranceEventManager_deregisterApplication", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restAssuranceAssuranceEventManagerDeregisterApplication" }, "task": true }, { "name": "restAssuranceAssuranceEventManagerRegisterApplication", "summary": "rest_assurance_AssuranceEventManager_registerApplication", "description": "rest_assurance_AssuranceEventManager_registerApplication", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restAssuranceAssuranceEventManagerRegisterApplication" }, "task": true }, { "name": "restAtmInterfaceGetAllConnectionProfile", "summary": "getAllConnectionProfile", "description": "Intention : RETRIEVER getAllConnectionProfile: instance-level retriever API getAllConnectionProfile of class atm.Interface instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "aInPortPointer", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInPortPointer", "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": "/restAtmInterfaceGetAllConnectionProfile" }, "task": true }, { "name": "restAutoconfigAutoConfigScriptManagerConfigure", "summary": "configure", "description": "Create and modify a script through the script manager. Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure on default instance autoconfig-manager of class autoconfig.AutoConfigScriptManager This API follows hierarchical config model rules. The newly created scripts full name.", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restAutoconfigAutoConfigScriptManagerConfigure" }, "task": true }, { "name": "restBgpMd5KeyRemoveAuthentication", "summary": "rest_bgp_Md5Key_removeAuthentication", "description": "rest_bgp_Md5Key_removeAuthentication", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restBgpMd5KeyRemoveAuthentication" }, "task": true }, { "name": "restBierBierResyncBierDatabase", "summary": "rest_bier_Bier_resyncBierDatabase", "description": "rest_bier_Bier_resyncBierDatabase", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restBierBierResyncBierDatabase" }, "task": true }, { "name": "restBundleInterfaceFindMembers", "summary": "findMembers", "description": "Intention : RETRIEVER findMembers: instance-level [object finder] (retriever) API findMembers of class bundle.Interface DescendantInfo: bundle.ApsInterface instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restBundleInterfaceFindMembers" }, "task": true }, { "name": "restBundleInterfaceTestSetPattern", "summary": "rest_bundle_Interface_testSetPattern", "description": "rest_bundle_Interface_testSetPattern", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restBundleInterfaceTestSetPattern" }, "task": true }, { "name": "restBundleMultiChassisApsInterfaceFindInstanceApsBundles", "summary": "findInstanceApsBundles", "description": "Intention : RETRIEVER findInstanceApsBundles: instance-level [object finder] (retriever) API findInstanceApsBundles of class bundle.MultiChassisApsInterface instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restBundleMultiChassisApsInterfaceFindInstanceApsBundles" }, "task": true }, { "name": "restBundleMultiChassisApsInterfaceGetDependencyCount", "summary": "getDependencyCount", "description": "Intention : RETRIEVER getDependencyCount: instance-level retriever API getDependencyCount of class bundle.MultiChassisApsInterface instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restBundleMultiChassisApsInterfaceGetDependencyCount" }, "task": true }, { "name": "restCacCacManagerBookBwForReservedTunnel", "summary": "rest_cac_CacManager_bookBwForReservedTunnel", "description": "rest_cac_CacManager_bookBwForReservedTunnel", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restCacCacManagerBookBwForReservedTunnel" }, "task": true }, { "name": "restCacCacManagerFindServicesUsingTunnel", "summary": "findServicesUsingTunnel", "description": "Retrieve Services that are currently using this Tunnel Intention : RETRIEVER findServicesUsingTunnel: class-level [object finder] (retriever) API findServicesUsingTunnel on default instance cac-mgr of class cac.CacManager The list of instances", "input": [ { "name": "aInTunnelFdn", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInTunnelFdn", "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": "/restCacCacManagerFindServicesUsingTunnel" }, "task": true }, { "name": "restCacCacManagerIsCacEnabled", "summary": "isCacEnabled", "description": "To check if CAC Bandwidth configuration is enabled on the services. Intention : RETRIEVER isCacEnabled: class-level retriever API isCacEnabled on default instance cac-mgr of class cac.CacManager", "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": "/restCacCacManagerIsCacEnabled" }, "task": true }, { "name": "restCacCacManagerVerifyCac", "summary": "rest_cac_CacManager_verifyCac", "description": "rest_cac_CacManager_verifyCac", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restCacCacManagerVerifyCac" }, "task": true }, { "name": "restCalltraceCallTraceConfigAddIPoECallTraceJob", "summary": "addIPoECallTraceJob", "description": "Add selective call trace job based on ipoe session. Intention : RETRIEVER addIPoECallTraceJob: class-level retriever API addIPoECallTraceJob of class calltrace.CallTraceConfig", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"circuitId\": \"string\", \"remoteId\": \"string\", \"sapFdn\": \"string\", \"macAddress\": \"string\", \"traceProfileName\": \"string\", \"maxJobs\": 123, \"traceExistingSessions\": \"boolean\", \"traceName\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "circuitId", "macAddress", "maxJobs", "objectClassName", "remoteId", "sapFdn", "siteId", "traceExistingSessions", "traceName", "traceProfileName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "circuitId": { "type": "string" }, "remoteId": { "type": "string" }, "sapFdn": { "type": "string" }, "macAddress": { "type": "string" }, "traceProfileName": { "type": "string" }, "maxJobs": { "type": "integer" }, "traceExistingSessions": { "type": "boolean", "default": false }, "traceName": { "type": "string" } }, "description": "Model containing the method level model for struct TraceInfoStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restCalltraceCallTraceConfigAddIPoECallTraceJob" }, "task": true }, { "name": "restCalltraceCallTraceConfigAddWlanGwUeCallTraceJob", "summary": "addWlanGwUeCallTraceJob", "description": "Add selective call trace job based on WLAN GW UE. Intention : RETRIEVER addWlanGwUeCallTraceJob: class-level retriever API addWlanGwUeCallTraceJob of class calltrace.CallTraceConfig", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"ieeeAddress\": \"string\", \"traceProfileName\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "ieeeAddress", "objectClassName", "siteId", "traceProfileName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "ieeeAddress": { "type": "string" }, "traceProfileName": { "type": "string" } }, "description": "Model containing the method level model for struct WlanGwUeTraceInfoStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restCalltraceCallTraceConfigAddWlanGwUeCallTraceJob" }, "task": true }, { "name": "restCalltraceCallTraceConfigRemoveIPoECallTraceJob", "summary": "removeIPoECallTraceJob", "description": "Remove selective call trace job based on ipoe session. Intention : RETRIEVER removeIPoECallTraceJob: class-level [administrative deletion] (retriever) API removeIPoECallTraceJob of class calltrace.CallTraceConfig", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"circuitId\": \"string\", \"remoteId\": \"string\", \"sapFdn\": \"string\", \"macAddress\": \"string\", \"traceName\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "circuitId", "macAddress", "objectClassName", "remoteId", "sapFdn", "siteId", "traceName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "circuitId": { "type": "string" }, "remoteId": { "type": "string" }, "sapFdn": { "type": "string" }, "macAddress": { "type": "string" }, "traceName": { "type": "string" } }, "description": "Model containing the method level model for struct RemoveTraceInfoStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restCalltraceCallTraceConfigRemoveIPoECallTraceJob" }, "task": true }, { "name": "restCalltraceCallTraceConfigRemoveWlanGwUeCallTraceJob", "summary": "removeWlanGwUeCallTraceJob", "description": "Remove selective call trace job based on WLAN GW UE. Intention : RETRIEVER removeWlanGwUeCallTraceJob: class-level [administrative deletion] (retriever) API removeWlanGwUeCallTraceJob of class calltrace.CallTraceConfig", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"ieeeAddress\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "ieeeAddress", "objectClassName", "siteId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "ieeeAddress": { "type": "string" } }, "description": "Model containing the method level model for struct RemoveWlanGwUeTraceInfoStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restCalltraceCallTraceConfigRemoveWlanGwUeCallTraceJob" }, "task": true }, { "name": "restCalltraceCallTraceConfigRequestClearCallTraceIpoeSession", "summary": "requestClearCallTraceIpoeSession", "description": "Request clearing of IPoE job with specific session key with the specified parameters. The siteId, sapFdn and macAddress are required. circuitId and remoteId are optional and are mutually exclusive. When this method returns, resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearCal...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"sapFdn\": \"string\", \"macAddress\": \"string\", \"circuitId\": \"string\", \"remoteId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "circuitId", "macAddress", "objectClassName", "remoteId", "sapFdn", "siteId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "sapFdn": { "type": "string" }, "macAddress": { "type": "string" }, "circuitId": { "type": "string" }, "remoteId": { "type": "string" } }, "description": "Model containing the method level model for struct ClearCallTraceIpoeSessionStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restCalltraceCallTraceConfigRequestClearCallTraceIpoeSession" }, "task": true }, { "name": "restCalltraceCallTraceConfigRequestClearCallTraceIpoeTrace", "summary": "requestClearCallTraceIpoeTrace", "description": "Request clearing of IPoE Jobs Started By Specific Trace with the specified parameters. The siteId and traceName are required. When this method returns, resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearCallTraceIpoeTrace: class-level modifier API requestClearCallTraceIpoeTrac...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"traceName\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "objectClassName", "siteId", "traceName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "traceName": { "type": "string" } }, "description": "Model containing the method level model for struct ClearCallTraceIpoeTraceStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restCalltraceCallTraceConfigRequestClearCallTraceIpoeTrace" }, "task": true }, { "name": "restCalltraceCallTraceFileRetrieveCallTraceFile", "summary": "retrieveCallTraceFile", "description": "Intention : RETRIEVER retrieveCallTraceFile: class-level retriever API retrieveCallTraceFile of class calltrace.CallTraceFile", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"jobStatus\": \"string\", \"cpmSlotNumber\": 123, \"cflashId\": \"string\", \"fileName\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "cflashId", "cpmSlotNumber", "fileName", "jobStatus", "siteId", "timeout" ], "properties": { "siteId": { "type": "string", "description": " Specifies the NE of the call-trace files(s).This is a required input parameter." }, "jobStatus": { "type": "string", "description": " Specifies the stauts of job, value could be either 'running' or 'finished'.This is an optional input parameter. default:-1" }, "cpmSlotNumber": { "type": "integer", "description": " Specifies the CPM slot where the cflash card containing the log file is present.Its value is between 1 and 128.This is an optional input parameter. Its value can only be specified if jobStatus is specified default:0" }, "cflashId": { "type": "string", "description": " Specifies the ID of the cflash card on the CPM board.Its value could be either cf1 or cf2.This is an optional input parameter. Its value can only be specified if jobStatus and cpmSlotNumber is specified. default:0" }, "fileName": { "type": "string", "description": " Specifies the name of the call-trace file.This is an optional input parameter.Its value can only be specified if jobStatus, cpmSlotNumber andcflashId is specified. default:" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns. default:300000" } }, "description": "Model containing the method level model for CallTraceFile.retrieveCallTraceFile to decode json data to internal NFM-P object model" } } ], "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": "/restCalltraceCallTraceFileRetrieveCallTraceFile" }, "task": true }, { "name": "restCalltraceCallTraceJobRetrieveCallTraceJobs", "summary": "retrieveCallTraceJobs", "description": "Retrieve call-trace jobs request with desired siteId, and (optional) ID, traceName, sapFdn, macAddress, circuitId, remoteId whose values are used to retrieve the call-trace jobs. Intention : RETRIEVER retrieveCallTraceJobs: class-level retriever API retrieveCallTraceJobs of class calltrace.CallTraceJob", "input": [ { "name": "body", "type": "object", "info": ": {\"retrieveCallTraceStruct\": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"id\": 123}, \"traceName\": \"string\", \"sapFdn\": \"string\", \"macAddress\": \"string\", \"circuitId\": \"string\", \"remoteId\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "circuitId", "macAddress", "remoteId", "retrieveCallTraceStruct", "sapFdn", "timeout", "traceName" ], "properties": { "retrieveCallTraceStruct": { "type": "object", "required": [ "id", "objectClassName", "siteId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "id": { "type": "integer" } }, "description": "Model containing the method level model for struct RetrieveCallTraceStruct. to decode json data to internal NFM-P object model" }, "traceName": { "type": "string", "description": " Specifies the trace name. Its optional parameter. default:" }, "sapFdn": { "type": "string", "description": " Specifies the FDN of SAP.Its optional parameter. default:" }, "macAddress": { "type": "string", "description": " Specifies the MAC address of IPoE Session. Its optional parameter. default:" }, "circuitId": { "type": "string", "description": " Specifies the circuit ID of IPoE Session. Its optional parameter. default:" }, "remoteId": { "type": "string", "description": " Specifies the remote ID of IPoE Session. Its optional parameter. default:" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns. default:300000" } }, "description": "Model containing the method level model for CallTraceJob.retrieveCallTraceJobs to decode json data to internal NFM-P object model" } } ], "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": "/restCalltraceCallTraceJobRetrieveCallTraceJobs" }, "task": true }, { "name": "restCalltraceCallTraceJobRetrieveWlanGwUeCallTraceJobs", "summary": "retrieveWlanGwUeCallTraceJobs", "description": "Retrieve call-trace jobs request with desired siteId, and optional IEEE address, whose values are used to retrieve the call-trace jobs. Intention : RETRIEVER retrieveWlanGwUeCallTraceJobs: class-level retriever API retrieveWlanGwUeCallTraceJobs of class calltrace.CallTraceJob", "input": [ { "name": "body", "type": "object", "info": ": {\"retrieveCallTraceStruct\": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"id\": 123}, \"ieeeAddress\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "ieeeAddress", "retrieveCallTraceStruct", "timeout" ], "properties": { "retrieveCallTraceStruct": { "type": "object", "required": [ "id", "objectClassName", "siteId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "id": { "type": "integer" } }, "description": "Model containing the method level model for struct RetrieveCallTraceStruct. to decode json data to internal NFM-P object model" }, "ieeeAddress": { "type": "string", "description": " Specifies the IEEE address of WLAN GW UE. It is an optional parameter.{P}IEEE address and ID within the RetrieveCallTraceStruct are mutually exclusive. default:" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns. default:300000" } }, "description": "Model containing the method level model for CallTraceJob.retrieveWlanGwUeCallTraceJobs to decode json data to internal NFM-P object model" } } ], "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": "/restCalltraceCallTraceJobRetrieveWlanGwUeCallTraceJobs" }, "task": true }, { "name": "restCalltraceCallTraceTraceRetrieveCallTraceTraces", "summary": "retrieveCallTraceTraces", "description": "Retrieve call-trace trace object with desired siteId, and optional ID or traceName whose values are used to retrieve the call-trace traces. Intention : RETRIEVER retrieveCallTraceTraces: class-level retriever API retrieveCallTraceTraces of class calltrace.CallTraceTrace", "input": [ { "name": "body", "type": "object", "info": ": {\"retrieveCallTraceStruct\": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"id\": 123}, \"traceName\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "retrieveCallTraceStruct", "timeout", "traceName" ], "properties": { "retrieveCallTraceStruct": { "type": "object", "required": [ "id", "objectClassName", "siteId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "id": { "type": "integer" } }, "description": "Model containing the method level model for struct RetrieveCallTraceStruct. to decode json data to internal NFM-P object model" }, "traceName": { "type": "string", "description": " Specifies the trace name. It is optional parameter. traceName and id are mutually exclusive. default:" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns. default:300000" } }, "description": "Model containing the method level model for CallTraceTrace.retrieveCallTraceTraces to decode json data to internal NFM-P object model" } } ], "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": "/restCalltraceCallTraceTraceRetrieveCallTraceTraces" }, "task": true }, { "name": "restClearClearCommandManagerRetrieveClearRequest", "summary": "retrieveClearRequest", "description": "Retrieve a request to obtain its result. Intention : RETRIEVER retrieveClearRequest: instance-level retriever API retrieveClearRequest on default instance clear-cmd-mgr of class clear.ClearCommandManager The request referenced by the handle or null if the handle has become invalid (the request is cleaned up by NFM-P or it has been reused for a more recent clear request).", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"requestId\": 123, \"requestedTime\": 123}", "required": false, "schema": { "type": "object", "required": [ "objectClassName", "requestId", "requestedTime" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "requestId": { "type": "integer" }, "requestedTime": { "type": "integer" } }, "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restClearClearCommandManagerRetrieveClearRequest" }, "task": true }, { "name": "restConnprofConnProfPolicyGetAllSonetChannels", "summary": "getAllSonetChannels", "description": "Intention : RETRIEVER getAllSonetChannels: instance-level retriever API getAllSonetChannels of class connprof.ConnProfPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restConnprofConnProfPolicyGetAllSonetChannels" }, "task": true }, { "name": "restConnprofConnProfPolicyGetAllVlanRanegSAPs", "summary": "getAllVlanRanegSAPs", "description": "Intention : RETRIEVER getAllVlanRanegSAPs: instance-level retriever API getAllVlanRanegSAPs of class connprof.ConnProfPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restConnprofConnProfPolicyGetAllVlanRanegSAPs" }, "task": true }, { "name": "restConnprofPssConnProfPolicyGetAllVlanRanegSAPs", "summary": "getAllVlanRanegSAPs", "description": "Intention : RETRIEVER getAllVlanRanegSAPs: instance-level retriever API getAllVlanRanegSAPs of class connprof.PssConnProfPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restConnprofPssConnProfPolicyGetAllVlanRanegSAPs" }, "task": true }, { "name": "restConnprofVlanConnProfPolicyGetVlanConnProfSAPs", "summary": "getVlanConnProfSAPs", "description": "Intention : RETRIEVER getVlanConnProfSAPs: instance-level retriever API getVlanConnProfSAPs of class connprof.VlanConnProfPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInConnectionProfile\": 123, \"aInServiceType\": 123, \"aInFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "aInConnectionProfile": { "type": "integer" }, "aInServiceType": { "type": "integer" }, "aInFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for VlanConnProfPolicy.getVlanConnProfSAPs to decode json data to internal NFM-P object model" } } ], "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": "/restConnprofVlanConnProfPolicyGetVlanConnProfSAPs" }, "task": true }, { "name": "restCrdtctrlCcEntryDefinitionFind", "summary": "find", "description": "Intention : RETRIEVER find: class-level [object finder] (retriever) API find of class crdtctrl.CcEntryDefinition DescendantInfo: crdtctrl.CcIpv6FilterEntry DescendantInfo: crdtctrl.CcIpFilterEntry", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restCrdtctrlCcEntryDefinitionFind" }, "task": true }, { "name": "restDbAuxiliaryDbBackupAuxDbBackup", "summary": "rest_db_AuxiliaryDbBackup_AuxDbBackup", "description": "rest_db_AuxiliaryDbBackup_AuxDbBackup", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restDbAuxiliaryDbBackupAuxDbBackup" }, "task": true }, { "name": "restDbDatabaseManagerBackup", "summary": "rest_db_DatabaseManager_backup", "description": "rest_db_DatabaseManager_backup", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restDbDatabaseManagerBackup" }, "task": true }, { "name": "restDbDatabaseManagerGetDbStatus", "summary": "getDbStatus", "description": "Determine the status of the Primary Standalone database. Value of 1 for UP Value of 2 for DOWN Intention : RETRIEVER getDbStatus: instance-level retriever API getDbStatus on default instance database-manager of class db.DatabaseManager", "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": "/restDbDatabaseManagerGetDbStatus" }, "task": true }, { "name": "restDbDatabaseManagerGetProxyStatus", "summary": "getProxyStatus", "description": "Determine the status of the database proxies. Bit value 00 for Primary Proxy DOWN, Standby Proxy DOWN Bit value 01 for Primary Proxy UP, Standby Proxy DOWN Bit value 10 for Primary Proxy DOWN, Standby Proxy UP Bit value 11 for Primary Proxy UP, Standby Proxy UP Intention : RETRIEVER getProxyStatus: instance-level retriever API getProxyStatus on default instance database-manager of class db.DatabaseManager", "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": "/restDbDatabaseManagerGetProxyStatus" }, "task": true }, { "name": "restDbDatabaseManagerGetStandbyDbStatus", "summary": "getStandbyDbStatus", "description": "Determine the status of the Standby database. Value of 4 for UP Value of 5 for DOWN Value of 6 for OUT OF SYNC Intention : RETRIEVER getStandbyDbStatus: instance-level retriever API getStandbyDbStatus on default instance database-manager of class db.DatabaseManager", "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": "/restDbDatabaseManagerGetStandbyDbStatus" }, "task": true }, { "name": "restDbDatabaseManagerIsDbRedundant", "summary": "isDbRedundant", "description": "Determine if the database is redundant (either Primary or Standby). Intention : RETRIEVER isDbRedundant: instance-level retriever API isDbRedundant on default instance database-manager of class db.DatabaseManager", "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": "/restDbDatabaseManagerIsDbRedundant" }, "task": true }, { "name": "restDbDatabaseManagerReinstantiateStandby", "summary": "rest_db_DatabaseManager_reinstantiateStandby", "description": "rest_db_DatabaseManager_reinstantiateStandby", "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": "/restDbDatabaseManagerReinstantiateStandby" }, "task": true }, { "name": "restDbDatabaseManagerSwitchover", "summary": "rest_db_DatabaseManager_switchover", "description": "rest_db_DatabaseManager_switchover", "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": "/restDbDatabaseManagerSwitchover" }, "task": true }, { "name": "restDbSizeConstrainedClassListUnusedClasses", "summary": "listUnusedClasses", "description": "Intention : RETRIEVER listUnusedClasses: class-level retriever API listUnusedClasses of class db.SizeConstrainedClass", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restDbSizeConstrainedClassListUnusedClasses" }, "task": true }, { "name": "restDbSizeConstraintPolicyConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: class-level [hierarchical administrative configuration/modification] (modifier) API configure of class db.SizeConstraintPolicy This API follows hierarchical config model rules.", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"policyId\": 123, \"description\": \"string\", \"rowThreshold\": 123, \"rowsToDelete\": 123, \"thresholdPolicy\": 123}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "policyId": { "type": "integer" }, "description": { "type": "string" }, "rowThreshold": { "type": "integer" }, "rowsToDelete": { "type": "integer" }, "thresholdPolicy": { "type": "integer" } }, "description": "Model containing the method level model for Interface ConfigInfo SizeConstraintPolicyConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restDbSizeConstraintPolicyConfigure" }, "task": true }, { "name": "restDctrAbstractVirtualComponentGlobalGetVirtualComponents", "summary": "getVirtualComponents", "description": "Gets the Virtual Machines and Containers for the VPRN or VPLS service or service site, service scope, or POD. Intention : RETRIEVER getVirtualComponents: class-level retriever API getVirtualComponents of class dctr.AbstractVirtualComponentGlobal DescendantInfo: dctr.Container DescendantInfo: dctr.VirtualMachine", "input": [ { "name": "aInSName", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInSName", "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": "/restDctrAbstractVirtualComponentGlobalGetVirtualComponents" }, "task": true }, { "name": "restDctrAbstractVirtualPortSetDefaultFlowAttributes", "summary": "rest_dctr_AbstractVirtualPort_setDefaultFlowAttributes", "description": "rest_dctr_AbstractVirtualPort_setDefaultFlowAttributes", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"srcPort\": 123, \"dstPort\": 123, \"transProtocol\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "dstPort", "srcPort", "transProtocol" ], "properties": { "srcPort": { "type": "integer", "description": " Default Flow Source Protocol default:0" }, "dstPort": { "type": "integer", "description": " Default Flow Destination Protocol default:0" }, "transProtocol": { "type": "string", "description": " Default Flow matching the TransPort Protocol default:0" } }, "description": "Model containing the method level model for AbstractVirtualPort.setDefaultFlowAttributes to decode json data to internal NFM-P object model" } } ], "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": "/restDctrAbstractVirtualPortSetDefaultFlowAttributes" }, "task": true }, { "name": "restDctrAbstractVirtualSiteFindAccessInterfaces", "summary": "findAccessInterfaces", "description": "Find the Access Interfaces associated with a given vSwitch-Site. Intention : RETRIEVER findAccessInterfaces: instance-level [object finder] (retriever) API findAccessInterfaces of class dctr.AbstractVirtualSite DescendantInfo: dctr.VplsVirtualSite DescendantInfo: dctr.VprnVirtualSite instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restDctrAbstractVirtualSiteFindAccessInterfaces" }, "task": true }, { "name": "restDctrAbstractVirtualSiteFindControlInstances", "summary": "findControlInstances", "description": "Find the control instances for a given vSwitch-Site. Intention : RETRIEVER findControlInstances: instance-level [object finder] (retriever) API findControlInstances of class dctr.AbstractVirtualSite DescendantInfo: dctr.VplsVirtualSite DescendantInfo: dctr.VprnVirtualSite instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restDctrAbstractVirtualSiteFindControlInstances" }, "task": true }, { "name": "restDctrAbstractVirtualSiteFindUpstreamRouters", "summary": "findUpstreamRouters", "description": "Find the Underlay Routers for a given vSwitch-Site. Intention : RETRIEVER findUpstreamRouters: instance-level [object finder] (retriever) API findUpstreamRouters of class dctr.AbstractVirtualSite DescendantInfo: dctr.VplsVirtualSite DescendantInfo: dctr.VprnVirtualSite instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restDctrAbstractVirtualSiteFindUpstreamRouters" }, "task": true }, { "name": "restDctrAbstractVirtualSiteFindVirtualPorts", "summary": "findVirtualPorts", "description": "Find the Virtual Ports associated with a given vSwitch-Site. Intention : RETRIEVER findVirtualPorts: instance-level [object finder] (retriever) API findVirtualPorts of class dctr.AbstractVirtualSite DescendantInfo: dctr.VplsVirtualSite DescendantInfo: dctr.VprnVirtualSite instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restDctrAbstractVirtualSiteFindVirtualPorts" }, "task": true }, { "name": "restDctrAbstractVirtualSwitchGlobalDiscoverUpstreamRouters", "summary": "rest_dctr_AbstractVirtualSwitchGlobal_discoverUpstreamRouters", "description": "rest_dctr_AbstractVirtualSwitchGlobal_discoverUpstreamRouters", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restDctrAbstractVirtualSwitchGlobalDiscoverUpstreamRouters" }, "task": true }, { "name": "restDctrAuditManagerAudit", "summary": "audit", "description": "Starts Audit action for all the objects under the hierarchy of the named objects in the input list. Intention : MODIFIER audit: class-level modifier API audit on default instance voa-mgr of class dctr.AuditManager The current state of the audit", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"fdn\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "fdn", "objectClassName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "fdn": { "type": "string" } }, "description": "Model containing the method level model for struct AuditParam. to decode json data to internal NFM-P object model" } } ], "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": "/restDctrAuditManagerAudit" }, "task": true }, { "name": "restDctrAuditManagerGetResult", "summary": "getResult", "description": "Returns the result of a completed audit operation (the final state can be failure !!!). Intention : RETRIEVER getResult: class-level retriever API getResult on default instance voa-mgr of class dctr.AuditManager The results from the last audit.", "input": [ { "name": "body", "type": "object", "info": ": {\"auditParam\": {\"objectClassName\": \"string\", \"fdn\": \"string\"}, \"objectType\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "auditParam", "objectType" ], "properties": { "auditParam": { "type": "object", "required": [ "fdn", "objectClassName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "fdn": { "type": "string" } }, "description": "Model containing the method level model for struct AuditParam. to decode json data to internal NFM-P object model" }, "objectType": { "type": "string", "description": " " } }, "description": "Model containing the method level model for AuditManager.getResult to decode json data to internal NFM-P object model" } } ], "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": "/restDctrAuditManagerGetResult" }, "task": true }, { "name": "restDctrAuditManagerGetStatus", "summary": "getStatus", "description": "Gets the latest state of the audit operation. Intention : RETRIEVER getStatus: class-level retriever API getStatus on default instance voa-mgr of class dctr.AuditManager The current state of the audit", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"fdn\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "fdn", "objectClassName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "fdn": { "type": "string" } }, "description": "Model containing the method level model for struct AuditParam. to decode json data to internal NFM-P object model" } } ], "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": "/restDctrAuditManagerGetStatus" }, "task": true }, { "name": "restDctrDCInventoryRecordGetDCInventory", "summary": "getDCInventory", "description": "returns a DCInventoryRecord filled with count values as specified in the input filter Intention : RETRIEVER getDCInventory: class-level retriever API getDCInventory of class dctr.DCInventoryRecord", "input": [ { "name": "body", "type": "object", "info": ": {\"aInDCName\": \"string\", \"aInCountFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "aInDCName": { "type": "string" }, "aInCountFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for DCInventoryRecord.getDCInventory to decode json data to internal NFM-P object model" } } ], "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": "/restDctrDCInventoryRecordGetDCInventory" }, "task": true }, { "name": "restDctrDataCenterDiscoverOverlayPath", "summary": "discoverOverlayPath", "description": "Intention : RETRIEVER discoverOverlayPath: class-level retriever API discoverOverlayPath of class dctr.DataCenter", "input": [ { "name": "body", "type": "object", "info": ": {\"adminDomainFDN\": \"string\", \"srcVPortFDN\": \"string\", \"dstVPortName\": \"string\", \"srcPort\": 123, \"dstPort\": 123, \"protocol\": 123, \"transProtocol\": 123, \"isActiveFlow\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "adminDomainFDN", "dstPort", "dstVPortName", "isActiveFlow", "protocol", "srcPort", "srcVPortFDN", "transProtocol" ], "properties": { "adminDomainFDN": { "type": "string", "description": " Admin Domain FDN" }, "srcVPortFDN": { "type": "string", "description": " Source Virtual Port FDN" }, "dstVPortName": { "type": "string", "description": " Destination Virtual port FDN." }, "srcPort": { "type": "integer", "description": " Application Source Port" }, "dstPort": { "type": "integer", "description": " Application Destination Port" }, "protocol": { "type": "integer", "description": " Underlay protocol Type(BGP=4,ISIS=2,OSPF=1)" }, "transProtocol": { "type": "integer", "description": " Transport Protocol Number" }, "isActiveFlow": { "type": "boolean", "description": " Overlay Path Discovery for Active Flow", "default": false } }, "description": "Model containing the method level model for DataCenter.discoverOverlayPath to decode json data to internal NFM-P object model" } } ], "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": "/restDctrDataCenterDiscoverOverlayPath" }, "task": true }, { "name": "restDctrDataCenterGetFlows", "summary": "getFlows", "description": "Retrieves Flows Between Two Virtual Machines using OSSI. Intention : RETRIEVER getFlows: class-level retriever API getFlows of class dctr.DataCenter", "input": [ { "name": "srcVPortFDN", "type": "string", "info": ": string", "required": false, "schema": { "title": "srcVPortFDN", "type": "string" } }, { "name": "dstVPortFDN", "type": "string", "info": ": string", "required": false, "schema": { "title": "dstVPortFDN", "type": "string" } }, { "name": "transProtocol", "type": "string", "info": ": string", "required": false, "schema": { "title": "transProtocol", "type": "string" } }, { "name": "dstPort", "type": "number", "info": ": 123", "required": false, "schema": { "title": "dstPort", "type": "number" } }, { "name": "activeFlowsCount", "type": "number", "info": ": 123", "required": false, "schema": { "title": "activeFlowsCount", "type": "number" } } ], "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": "/restDctrDataCenterGetFlows" }, "task": true }, { "name": "restDctrNsgGroupFindNsgsInGroup", "summary": "findNsgsInGroup", "description": "Find the Nsgs associated with a given Nsg Group. Intention : RETRIEVER findNsgsInGroup: instance-level [object finder] (retriever) API findNsgsInGroup of class dctr.NsgGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restDctrNsgGroupFindNsgsInGroup" }, "task": true }, { "name": "restDctrNsgUbrGroupFindNsgUbrsInGroup", "summary": "findNsgUbrsInGroup", "description": "Find the Nsg Ubrs associated with a given Nsg Ubr Group. Intention : RETRIEVER findNsgUbrsInGroup: instance-level [object finder] (retriever) API findNsgUbrsInGroup of class dctr.NsgUbrGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restDctrNsgUbrGroupFindNsgUbrsInGroup" }, "task": true }, { "name": "restDctrUpstreamRouterBindingGetUpstreamRouters", "summary": "getUpstreamRouters", "description": "Retrieve the Underlay Routers for a given target in a service. Intention : RETRIEVER getUpstreamRouters: class-level retriever API getUpstreamRouters of class dctr.UpstreamRouterBinding", "input": [ { "name": "body", "type": "object", "info": ": {\"targetIp\": \"string\", \"targetType\": 123, \"serviceId\": 123, \"svcComponentId\": 123}", "required": false, "schema": { "type": "object", "required": [ "serviceId", "svcComponentId", "targetIp", "targetType" ], "properties": { "targetIp": { "type": "string", "description": " " }, "targetType": { "type": "integer", "description": " " }, "serviceId": { "type": "integer", "description": " " }, "svcComponentId": { "type": "integer", "description": " " } }, "description": "Model containing the method level model for UpstreamRouterBinding.getUpstreamRouters to decode json data to internal NFM-P object model" } } ], "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": "/restDctrUpstreamRouterBindingGetUpstreamRouters" }, "task": true }, { "name": "restDctrVSDResyncVSwitches", "summary": "rest_dctr_VSD_resyncVSwitches", "description": "rest_dctr_VSD_resyncVSwitches", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restDctrVSDResyncVSwitches" }, "task": true }, { "name": "restDctrVirtualNodeGetVirtualComponentsForVnode", "summary": "getVirtualComponentsForVnode", "description": "Gets the Parent Virtual Components for the instance Intention : RETRIEVER getVirtualComponentsForVnode: class-level retriever API getVirtualComponentsForVnode of class dctr.VirtualNode", "input": [ { "name": "aInVnodeIp", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInVnodeIp", "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": "/restDctrVirtualNodeGetVirtualComponentsForVnode" }, "task": true }, { "name": "restDctrVirtualNodeGetVirtualPortsForVnode", "summary": "getVirtualPortsForVnode", "description": "Gets the Parent Virtual Machines for the instance Intention : RETRIEVER getVirtualPortsForVnode: class-level retriever API getVirtualPortsForVnode of class dctr.VirtualNode", "input": [ { "name": "aInVnodeIp", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInVnodeIp", "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": "/restDctrVirtualNodeGetVirtualPortsForVnode" }, "task": true }, { "name": "restDhcpAbstractAddressPoolDhcpStickyLeaseAction", "summary": "dhcpStickyLeaseAction", "description": "dhcpStickyLeaseAction allows to request an action to be performed upon a Sticky Lease instance. To create a Sticky Lease instance, write the name of the entry to be created in aInHostName, and set the required action in the object aInStickyLseActActionType. NOTE: This method is only supported on Local DHCP v4 Server and Address Pool. Intention : MODIFIER dhcpStickyLeaseAction: class-level modifier API dhcpStickyLeaseAction of class dhcp.AbstractAddressPool DescendantInfo: dhcp.AddressPoo...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInCircuitId\": \"string\", \"aInRoutingInstance\": \"string\", \"aInLocalDhcpServerName\": \"string\", \"aInAddressPoolName\": \"string\", \"aInHostName\": \"string\", \"aInMacAddress\": \"string\", \"aInClientId\": \"string\", \"aInStickyLseAddressType\": \"string\", \"aInStickyLseAddress\": \"string\", \"aInTimeout\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInCircuitId": { "type": "string" }, "aInRoutingInstance": { "type": "string" }, "aInLocalDhcpServerName": { "type": "string" }, "aInAddressPoolName": { "type": "string" }, "aInHostName": { "type": "string" }, "aInMacAddress": { "type": "string" }, "aInClientId": { "type": "string" }, "aInStickyLseAddressType": { "type": "string" }, "aInStickyLseAddress": { "type": "string" }, "aInTimeout": { "type": "integer" } }, "description": "Model containing the method level model for AbstractAddressPool.dhcpStickyLeaseAction to decode json data to internal NFM-P object model" } } ], "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": "/restDhcpAbstractAddressPoolDhcpStickyLeaseAction" }, "task": true }, { "name": "restDhcpAbstractDhcpServerFailoverForcePartnerDown", "summary": "forcePartnerDown", "description": "This method forces the failover partner-down only if failover operational state is 'No Communication'. Intention : MODIFIER forcePartnerDown: class-level modifier API forcePartnerDown of class dhcp.AbstractDhcpServerFailover DescendantInfo: dhcp.LocalDhcpPoolFailover DescendantInfo: dhcp.LocalDhcpServerFailover", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInRoutingInstanceName\": \"string\", \"aInDHCPServerName\": \"string\", \"aInDHCPServerPoolName\": \"string\", \"aInTimeout\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInRoutingInstanceName": { "type": "string" }, "aInDHCPServerName": { "type": "string" }, "aInDHCPServerPoolName": { "type": "string" }, "aInTimeout": { "type": "integer" } }, "description": "Model containing the method level model for AbstractDhcpServerFailover.forcePartnerDown to decode json data to internal NFM-P object model" } } ], "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": "/restDhcpAbstractDhcpServerFailoverForcePartnerDown" }, "task": true }, { "name": "restDhcpAddressPoolResyncDeclinedAddresses", "summary": "resyncDeclinedAddresses", "description": "This method gets the declined address entries from the network. Intention : RETRIEVER resyncDeclinedAddresses: class-level retriever API resyncDeclinedAddresses of class dhcp.AddressPool The number of declined addresses.", "input": [ { "name": "body", "type": "object", "info": ": {\"aInRtrId\": \"string\", \"aInLocalDhcpServerName\": \"string\", \"aInAddressPoolName\": \"string\", \"aInVirtualRtrId\": 123, \"aInDhcpSvrSubnetAddress\": \"string\", \"aInDhcpSvrSubnetPrefixLength\": 123, \"aInDhcpSvrFreeAddress\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInRtrId": { "type": "string" }, "aInLocalDhcpServerName": { "type": "string" }, "aInAddressPoolName": { "type": "string" }, "aInVirtualRtrId": { "type": "integer" }, "aInDhcpSvrSubnetAddress": { "type": "string" }, "aInDhcpSvrSubnetPrefixLength": { "type": "integer" }, "aInDhcpSvrFreeAddress": { "type": "string" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns." } }, "description": "Model containing the method level model for AddressPool.resyncDeclinedAddresses to decode json data to internal NFM-P object model" } } ], "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": "/restDhcpAddressPoolResyncDeclinedAddresses" }, "task": true }, { "name": "restDhcpAddressPoolResyncFreeAddresses", "summary": "resyncFreeAddresses", "description": "This method gets the free address entries from the network. Intention : RETRIEVER resyncFreeAddresses: class-level retriever API resyncFreeAddresses of class dhcp.AddressPool The number of free addresses.", "input": [ { "name": "body", "type": "object", "info": ": {\"aInRtrId\": \"string\", \"aInLocalDhcpServerName\": \"string\", \"aInAddressPoolName\": \"string\", \"aInVirtualRtrId\": 123, \"aInDhcpSvrSubnetAddress\": \"string\", \"aInDhcpSvrSubnetPrefixLength\": 123, \"aInDhcpSvrFreeAddress\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInRtrId": { "type": "string" }, "aInLocalDhcpServerName": { "type": "string" }, "aInAddressPoolName": { "type": "string" }, "aInVirtualRtrId": { "type": "integer" }, "aInDhcpSvrSubnetAddress": { "type": "string" }, "aInDhcpSvrSubnetPrefixLength": { "type": "integer" }, "aInDhcpSvrFreeAddress": { "type": "string" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns." } }, "description": "Model containing the method level model for AddressPool.resyncFreeAddresses to decode json data to internal NFM-P object model" } } ], "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": "/restDhcpAddressPoolResyncFreeAddresses" }, "task": true }, { "name": "restDhcpLocalDhcp6ServerShowDhcp6Leases", "summary": "showDhcp6Leases", "description": "This method retrieves from the network the leases for a local DHCPv6 server, by sending the CLI command show router [routerId] dhcp6 local-dhcp-server [serverName] leases [ip-address prefix] detail. Method call example: <dhcp.LocalDhcp6Server.showDhcp6Leases xmlns=\"xmlapi_1.0\"> <isSynchronized>true <clientId>user@1< clientId> <systemScriptTargetConfigInfo> <script.TargetScript> <actionMask> <bit>create< bit> < actionMask> <targetObj...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"isSynchronized\": \"boolean\", \"clientId\": \"string\", \"systemScriptTargetConfigInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}}", "required": false, "schema": { "type": "object", "required": [ "clientId", "isSynchronized", "systemScriptTargetConfigInfo" ], "properties": { "isSynchronized": { "type": "boolean", "description": " Identifies if the call to execute the script should wait until all scripts have beenexecuted. True to wait, false otherwise.", "default": false }, "clientId": { "type": "string", "description": " Identifies the client Id that is requesting the execution (used for sending an event tothe specific client when execution is complete)." }, "systemScriptTargetConfigInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for LocalDhcp6Server.showDhcp6Leases to decode json data to internal NFM-P object model" } } ], "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": "/restDhcpLocalDhcp6ServerShowDhcp6Leases" }, "task": true }, { "name": "restDhcpLocalDhcpServerClearDhcpServerLeases", "summary": "clearDhcpServerLeases", "description": "Request clearing one or all leases of a given Local DHCP Server on Service ID . The siteId dhcpSvrName is mandatory. If serviceId is not given, the method will use the base routing instance. ipAddress and prefix are optional. If not specified, all leases will be cleared, otherwise lease on given ipAddress and prefix will be cleared. Clear result will be displayed on Clear Status tab on given Local DHCP Server. Intention : MODIFIER clearDhcpServerLeases: class-level [functionality clearing] (...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"serviceId\": 123, \"dhcpSvrName\": \"string\", \"ipAddress\": \"string\", \"prefix\": 123, \"state\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "dhcpSvrName", "ipAddress", "objectClassName", "prefix", "serviceId", "siteId", "state" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "serviceId": { "type": "integer" }, "dhcpSvrName": { "type": "string" }, "ipAddress": { "type": "string" }, "prefix": { "type": "integer" }, "state": { "type": "string" } }, "description": "Model containing the method level model for struct ClearDhcpLeaseStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restDhcpLocalDhcpServerClearDhcpServerLeases" }, "task": true }, { "name": "restDhcpLocalDhcpServerClearDhcpServerStickyLeases", "summary": "clearDhcpServerStickyLeases", "description": "Request clearing sticky leases of a given Local DHCP Server on Service ID. The siteId dhcpSvrName is mandatory. If serviceId is not specified, it will be Base routing instance as default. If hostName is specified, lease for the given hostName will be cleared. If hostName-Prefix is specified, leases for the given hosts starting with the specified prefix will be cleared. hostName and hostName-Prefix are mutually exclusive. If both parameters are specified only hostName will be used to clear the st...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"serviceId\": 123, \"dhcpSvrName\": \"string\", \"hostName\": \"string\", \"hostNamePrefix\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "dhcpSvrName", "hostName", "hostNamePrefix", "objectClassName", "serviceId", "siteId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "serviceId": { "type": "integer" }, "dhcpSvrName": { "type": "string" }, "hostName": { "type": "string", "description": " default: yes:" }, "hostNamePrefix": { "type": "string", "description": " default: yes:" } }, "description": "Model containing the method level model for struct ClearDhcpStickyLeasesStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restDhcpLocalDhcpServerClearDhcpServerStickyLeases" }, "task": true }, { "name": "restDhcpLocalDhcpServerResyncLeases", "summary": "resyncLeases", "description": "This method gets the free address entries from the network. Intention : RETRIEVER resyncLeases: class-level retriever API resyncLeases of class dhcp.LocalDhcpServer The number of leases.", "input": [ { "name": "body", "type": "object", "info": ": {\"aInRtrId\": \"string\", \"aInLocalDhcpServerName\": \"string\", \"aInVirtualRtrId\": 123, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInRtrId": { "type": "string" }, "aInLocalDhcpServerName": { "type": "string" }, "aInVirtualRtrId": { "type": "integer" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns." } }, "description": "Model containing the method level model for LocalDhcpServer.resyncLeases to decode json data to internal NFM-P object model" } } ], "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": "/restDhcpLocalDhcpServerResyncLeases" }, "task": true }, { "name": "restDhcpStickyLeaseDataRetrieveStickyLeases", "summary": "retrieveStickyLeases", "description": "Method used to retrieve Dhcp Server Sticky Leases. Intention : RETRIEVER retrieveStickyLeases: class-level retriever API retrieveStickyLeases of class dhcp.StickyLeaseData List of Dhcp Server Sticky Leases.", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInRoutingInstance\": \"string\", \"aInDhcpServerName\": \"string\", \"aInLeaseHostName\": \"string\", \"aInLeaseHostNamePrefix\": \"string\", \"aInTimeout\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInRoutingInstance": { "type": "string" }, "aInDhcpServerName": { "type": "string" }, "aInLeaseHostName": { "type": "string" }, "aInLeaseHostNamePrefix": { "type": "string" }, "aInTimeout": { "type": "integer" } }, "description": "Model containing the method level model for StickyLeaseData.retrieveStickyLeases to decode json data to internal NFM-P object model" } } ], "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": "/restDhcpStickyLeaseDataRetrieveStickyLeases" }, "task": true }, { "name": "restDiameterDiameterAppPolicyClearCcrtReplaySession", "summary": "clearCcrtReplaySession", "description": "Request clearing of CCR Terminate replay session with the specified parameters. The siteId and diameterAppPolicy are required. When this method returns, resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER clearCcrtReplaySession: class-level [functionality clearing] (modifier) API clearCcrt...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"diameterAppPolicy\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "diameterAppPolicy", "siteId" ], "properties": { "siteId": { "type": "string", "description": " Specifies the NE.This is a required input parameter." }, "diameterAppPolicy": { "type": "string", "description": " Specifies the Diameter Application Policy name.This is a required input parameter." } }, "description": "Model containing the method level model for DiameterAppPolicy.clearCcrtReplaySession to decode json data to internal NFM-P object model" } } ], "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": "/restDiameterDiameterAppPolicyClearCcrtReplaySession" }, "task": true }, { "name": "restDiameterDiameterAppPolicyClearCcrtReplayStatistics", "summary": "clearCcrtReplayStatistics", "description": "Request clearing of CCR Terminate replay statistics with the specified parameters. The siteId and diameterAppPolicy are required. When this method returns, resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER clearCcrtReplayStatistics: class-level [functionality clearing] (modifier) API cle...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"diameterAppPolicy\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "diameterAppPolicy", "siteId" ], "properties": { "siteId": { "type": "string", "description": " Specifies the NE.This is a required input parameter." }, "diameterAppPolicy": { "type": "string", "description": " Specifies the Diameter Application Policy name.This is a required input parameter." } }, "description": "Model containing the method level model for DiameterAppPolicy.clearCcrtReplayStatistics to decode json data to internal NFM-P object model" } } ], "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": "/restDiameterDiameterAppPolicyClearCcrtReplayStatistics" }, "task": true }, { "name": "restDiameterDiameterSeCcrtReplayRetrieveCcrtReplay", "summary": "retrieveCcrtReplay", "description": "Method used to retrieve information about a Diameter Session that is in CCR-T replay mode from NE. Intention : RETRIEVER retrieveCcrtReplay: class-level retriever API retrieveCcrtReplay of class diameter.DiameterSeCcrtReplay", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInCcrtReplayId\": 123, \"aInAppPolicyName\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInSiteId": { "type": "string" }, "aInCcrtReplayId": { "type": "integer" }, "aInAppPolicyName": { "type": "string" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait before receiving the results.The method returns if no results are received in the given time.This is an optional input parameter. The default value is 5 minutes (300000). default:300000" } }, "description": "Model containing the method level model for DiameterSeCcrtReplay.retrieveCcrtReplay to decode json data to internal NFM-P object model" } } ], "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": "/restDiameterDiameterSeCcrtReplayRetrieveCcrtReplay" }, "task": true }, { "name": "restDynsvcDynSvcAuthenticationClearPassword", "summary": "rest_dynsvc_DynSvcAuthentication_clearPassword", "description": "rest_dynsvc_DynSvcAuthentication_clearPassword", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restDynsvcDynSvcAuthenticationClearPassword" }, "task": true }, { "name": "restDynsvcDynSvcDataTriggerRequestClearDynSvcDataTrigger", "summary": "requestClearDynSvcDataTrigger", "description": "Request clearing of Dynamic Service Data-Triggers with the specified parameters. The siteId and sapId are required. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearDynSvcDataTrigger: class-level modifier API requestClearDynSvcDataTrigger of class d...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"sapId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "objectClassName", "sapId", "siteId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "sapId": { "type": "string" } }, "description": "Model containing the method level model for struct ClearDynSvcDataTriggerStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restDynsvcDynSvcDataTriggerRequestClearDynSvcDataTrigger" }, "task": true }, { "name": "restDynsvcDynSvcDataTriggerRetrieveDynSvcDataTriggers", "summary": "retrieveDynSvcDataTriggers", "description": "Intention : RETRIEVER retrieveDynSvcDataTriggers: class-level retriever API retrieveDynSvcDataTriggers of class dynsvc.DynSvcDataTrigger", "input": [ { "name": "body", "type": "object", "info": ": {\"retrieveDynSvcDataTriggersStruct\": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"portName\": \"string\", \"outerEncapValue\": 123, \"innerEncapValue\": 123}, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "retrieveDynSvcDataTriggersStruct", "timeout" ], "properties": { "retrieveDynSvcDataTriggersStruct": { "type": "object", "required": [ "innerEncapValue", "objectClassName", "outerEncapValue", "portName", "siteId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "portName": { "type": "string" }, "outerEncapValue": { "type": "integer" }, "innerEncapValue": { "type": "integer" } }, "description": "Model containing the method level model for struct RetrieveDynSvcDataTriggersStruct. to decode json data to internal NFM-P object model" }, "timeout": { "type": "integer", "description": " (Optional) The number of milliseconds to wait beforereceiving the results. If the results are notreceived in the given time, the method returns. default:0" } }, "description": "Model containing the method level model for DynSvcDataTrigger.retrieveDynSvcDataTriggers to decode json data to internal NFM-P object model" } } ], "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": "/restDynsvcDynSvcDataTriggerRetrieveDynSvcDataTriggers" }, "task": true }, { "name": "restDynsvcDynSvcNeConfigRetrieveRootObjects", "summary": "retrieveRootObjects", "description": "Method used to query the NE for Root Objects. Intention : RETRIEVER retrieveRootObjects: class-level retriever API retrieveRootObjects of class dynsvc.DynSvcNeConfig", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "objectClassName", "siteId", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct DynSvcInfoRetrievalStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restDynsvcDynSvcNeConfigRetrieveRootObjects" }, "task": true }, { "name": "restDynsvcDynSvcNeConfigRetrieveScriptSnippets", "summary": "retrieveScriptSnippets", "description": "Method used to query the NE for Script Snippets. Intention : RETRIEVER retrieveScriptSnippets: class-level retriever API retrieveScriptSnippets of class dynsvc.DynSvcNeConfig", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "objectClassName", "siteId", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct DynSvcInfoRetrievalStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restDynsvcDynSvcNeConfigRetrieveScriptSnippets" }, "task": true }, { "name": "restDynsvcDynSvcSnippetInfoRetrieveScriptSnippetReferences", "summary": "retrieveScriptSnippetReferences", "description": "Method used to query the NE for Script References. Intention : RETRIEVER retrieveScriptSnippetReferences: class-level retriever API retrieveScriptSnippetReferences of class dynsvc.DynSvcSnippetInfo", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"snippetName\": \"string\", \"snippetInstance\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "objectClassName", "siteId", "snippetInstance", "snippetName", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "snippetName": { "type": "string" }, "snippetInstance": { "type": "string" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct DynSvcSnippetInfoRetrievalStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restDynsvcDynSvcSnippetInfoRetrieveScriptSnippetReferences" }, "task": true }, { "name": "restDynsvcDynSvcSnippetInfoRetrieveScriptSnippetReservedIdentifiers", "summary": "retrieveScriptSnippetReservedIdentifiers", "description": "Method used to query the NE for Script Reserved Identifiers. Intention : RETRIEVER retrieveScriptSnippetReservedIdentifiers: class-level retriever API retrieveScriptSnippetReservedIdentifiers of class dynsvc.DynSvcSnippetInfo", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"snippetName\": \"string\", \"snippetInstance\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "objectClassName", "siteId", "snippetInstance", "snippetName", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "snippetName": { "type": "string" }, "snippetInstance": { "type": "string" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct DynSvcSnippetInfoRetrievalStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restDynsvcDynSvcSnippetInfoRetrieveScriptSnippetReservedIdentifiers" }, "task": true }, { "name": "restDynsvcDynSvcSnippetInfoRetrieveScriptSnippetRootObjects", "summary": "retrieveScriptSnippetRootObjects", "description": "Method used to query the NE for Script Root Objects. Intention : RETRIEVER retrieveScriptSnippetRootObjects: class-level retriever API retrieveScriptSnippetRootObjects of class dynsvc.DynSvcSnippetInfo", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"snippetName\": \"string\", \"snippetInstance\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "objectClassName", "siteId", "snippetInstance", "snippetName", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "snippetName": { "type": "string" }, "snippetInstance": { "type": "string" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct DynSvcSnippetInfoRetrievalStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restDynsvcDynSvcSnippetInfoRetrieveScriptSnippetRootObjects" }, "task": true }, { "name": "restEpipeEpipeRestoreServiceForThroughputTest", "summary": "restoreServiceForThroughputTest", "description": "Restore the service from the throughput test. Intention : MODIFIER restoreServiceForThroughputTest: class-level modifier API restoreServiceForThroughputTest of class epipe.Epipe A list of error messages.", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restEpipeEpipeRestoreServiceForThroughputTest" }, "task": true }, { "name": "restEquipmentBaseCardForceReboot", "summary": "rest_equipment_BaseCard_forceReboot", "description": "rest_equipment_BaseCard_forceReboot", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentBaseCardForceReboot" }, "task": true }, { "name": "restEquipmentBaseCardReset", "summary": "rest_equipment_BaseCard_reset", "description": "rest_equipment_BaseCard_reset", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"resetType\": \"string\", \"mode\": \"string\", \"fwUpgrade\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "fwUpgrade", "mode", "resetType" ], "properties": { "resetType": { "type": "string", "description": " This parameter defines which type of reset is to be sent to the card." }, "mode": { "type": "string", "description": " Command Mode - identifies the Command Execution Mode. default:NORM" }, "fwUpgrade": { "type": "string", "description": " This parameter identifies the firmware upgrade option during reboot.{UL}{LI}Yes - Card scope FW image is downloaded from the Main Shelf First Level Controller{BR}to the target card. A cold restart is then instantiated without PortGroup FW image(s) upgrade.{LI}No - Card scope FW image is not downloaded before reboot.{LI}Yes including Port Group - Card scope FW image is downloaded from the Main Shelf First Level Controller{BR}to the target card. A cold restart is then instantiated with all PortGroup FW image(s) upgrade. default:N" } }, "description": "Model containing the method level model for BaseCard.reset to decode json data to internal NFM-P object model" } } ], "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": "/restEquipmentBaseCardReset" }, "task": true }, { "name": "restEquipmentBaseCardSoftReset", "summary": "rest_equipment_BaseCard_softReset", "description": "rest_equipment_BaseCard_softReset", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restEquipmentBaseCardSoftReset" }, "task": true }, { "name": "restEquipmentCardReboot", "summary": "rest_equipment_Card_reboot", "description": "rest_equipment_Card_reboot", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentCardReboot" }, "task": true }, { "name": "restEquipmentCardFirmwareCardColdReboot", "summary": "rest_equipment_CardFirmware_cardColdReboot", "description": "rest_equipment_CardFirmware_cardColdReboot", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentCardFirmwareCardColdReboot" }, "task": true }, { "name": "restEquipmentCardFirmwareHitlessUpgrade", "summary": "rest_equipment_CardFirmware_hitlessUpgrade", "description": "rest_equipment_CardFirmware_hitlessUpgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentCardFirmwareHitlessUpgrade" }, "task": true }, { "name": "restEquipmentCardSlotConfigurePSSCard", "summary": "configurePSSCard", "description": "Intention : MODIFIER configurePSSCard: class-level [hierarchical administrative configuration/modification] (modifier) API configurePSSCard of class equipment.CardSlot This API follows hierarchical config model rules. DescendantInfo: hip.EMSCardSlot", "input": [ { "name": "body", "type": "object", "info": ": {\"fdn\": \"string\", \"cardType\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "cardType", "fdn" ], "properties": { "fdn": { "type": "string", "description": " " }, "cardType": { "type": "string", "description": " " } }, "description": "Model containing the method level model for CardSlot.configurePSSCard to decode json data to internal NFM-P object model" } } ], "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": "/restEquipmentCardSlotConfigurePSSCard" }, "task": true }, { "name": "restEquipmentCardSwapTaskInitiateCardSwap", "summary": "rest_equipment_CardSwapTask_initiateCardSwap", "description": "rest_equipment_CardSwapTask_initiateCardSwap", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentCardSwapTaskInitiateCardSwap" }, "task": true }, { "name": "restEquipmentControlProcessorRebootHold", "summary": "rest_equipment_ControlProcessor_rebootHold", "description": "rest_equipment_ControlProcessor_rebootHold", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentControlProcessorRebootHold" }, "task": true }, { "name": "restEquipmentControlProcessorRereadCpmBootOptions", "summary": "rest_equipment_ControlProcessor_rereadCpmBootOptions", "description": "rest_equipment_ControlProcessor_rereadCpmBootOptions", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentControlProcessorRereadCpmBootOptions" }, "task": true }, { "name": "restEquipmentControlProcessorSwitchToRedundantCpm", "summary": "rest_equipment_ControlProcessor_switchToRedundantCpm", "description": "rest_equipment_ControlProcessor_switchToRedundantCpm", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentControlProcessorSwitchToRedundantCpm" }, "task": true }, { "name": "restEquipmentDryContactFindValidAmplifierCardsforConnectedTo", "summary": "findValidAmplifierCardsforConnectedTo", "description": "Intention : RETRIEVER findValidAmplifierCardsforConnectedTo: instance-level [object finder] (retriever) API findValidAmplifierCardsforConnectedTo of class equipment.DryContact instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "aInSiteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInSiteId", "type": "string" } }, { "name": "aInShelfId", "type": "number", "info": ": 123", "required": false, "schema": { "title": "aInShelfId", "type": "number" } }, { "name": "aInSlotId", "type": "number", "info": ": 123", "required": false, "schema": { "title": "aInSlotId", "type": "number" } } ], "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": "/restEquipmentDryContactFindValidAmplifierCardsforConnectedTo" }, "task": true }, { "name": "restEquipmentEquipmentGetDependencyCount", "summary": "getDependencyCount", "description": "Intention : RETRIEVER getDependencyCount: instance-level retriever API getDependencyCount of class equipment.Equipment DescendantInfo: equipment.PowerSupply DescendantInfo: equipment.ShelfPDU DescendantInfo: opticalequipment.VtsChannel DescendantInfo: sonetequipment.Sts12Channel DescendantInfo: equipment.PowerSupplyTray DescendantInfo: hip.EMSShelf DescendantInfo: equipment.FAM DescendantInfo: equipment.MediaAdaptor DescendantInfo: equipment.Fan DescendantInfo: equipment...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentEquipmentGetDependencyCount" }, "task": true }, { "name": "restEquipmentMCMCardSlotRemoveMCMCard", "summary": "removeMCMCard", "description": "Intention : MODIFIER removeMCMCard: instance-level [administrative deletion] (modifier) API removeMCMCard of class equipment.MCMCardSlot instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentMCMCardSlotRemoveMCMCard" }, "task": true }, { "name": "restEquipmentMdaStaticMacFdbClearFib", "summary": "rest_equipment_MdaStaticMacFdb_clearFib", "description": "rest_equipment_MdaStaticMacFdb_clearFib", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"shelfId\": 123, \"slotId\": 123, \"daughterCardSlotId\": 123}", "required": false, "schema": { "type": "object", "required": [ "daughterCardSlotId", "shelfId", "siteId", "slotId" ], "properties": { "siteId": { "type": "string", "description": " " }, "shelfId": { "type": "integer", "description": " " }, "slotId": { "type": "integer", "description": " " }, "daughterCardSlotId": { "type": "integer", "description": " " } }, "description": "Model containing the method level model for MdaStaticMacFdb.clearFib to decode json data to internal NFM-P object model" } } ], "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": "/restEquipmentMdaStaticMacFdbClearFib" }, "task": true }, { "name": "restEquipmentMdaStaticMacFdbResync", "summary": "rest_equipment_MdaStaticMacFdb_resync", "description": "rest_equipment_MdaStaticMacFdb_resync", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restEquipmentMdaStaticMacFdbResync" }, "task": true }, { "name": "restEquipmentNeCardSwapTaskInitiateCardSwap", "summary": "rest_equipment_NeCardSwapTask_initiateCardSwap", "description": "rest_equipment_NeCardSwapTask_initiateCardSwap", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentNeCardSwapTaskInitiateCardSwap" }, "task": true }, { "name": "restEquipmentPCMTrayRemovePcm", "summary": "removePcm", "description": "Intention : MODIFIER removePcm: instance-level [administrative deletion] (modifier) API removePcm of class equipment.PCMTray instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentPCMTrayRemovePcm" }, "task": true }, { "name": "restEquipmentPhysicalPortRequestClearEfmOamEventLogs", "summary": "requestClearEfmOamEventLogs", "description": "Request clearing of EFM-OAM Event Logs. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearEfmOamEventLogs: instance-level modifier API requestClearEfmOamEventLogs of class equipment.PhysicalPort DescendantInfo: hip.EMSPort instanceFullName : disti...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restEquipmentPhysicalPortRequestClearEfmOamEventLogs" }, "task": true }, { "name": "restEquipmentPhysicalPortRequestClearSubVlanStats", "summary": "requestClearSubVlanStats", "description": "Request clearing of Subscriber VLAN statistics. Statistics will be for all service access points with the corresponding port id and outer encap value. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearSubVlanStats: class-level modifier API requestClearSubVlanStats of class equipment.PhysicalPort DescendantInfo: hip.EMSPort A request handle which allows the...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"portName\": \"string\", \"vlanId\": 123}", "required": false, "schema": { "type": "object", "required": [ "portName", "siteId", "vlanId" ], "properties": { "siteId": { "type": "string", "description": " Specifies Site ID of the Subscriber VLAN Statistics to be cleared.This is mandatory parameter." }, "portName": { "type": "string", "description": " Specifies port of the Subscriber VLAN Statistics to be cleared.This is mandatory parameter." }, "vlanId": { "type": "integer", "description": " Specifies VLAN ID the Subscriber VLAN Statistics to be cleared.This value is equal to the outer encapsulation value on the Service Access Point.If set to -1, all Subscriber VLAN Statistics on the specified port will be cleared. default:-1" } }, "description": "Model containing the method level model for PwPort.requestClearSubVlanStats to decode json data to internal NFM-P object model" } } ], "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": "/restEquipmentPhysicalPortRequestClearSubVlanStats" }, "task": true }, { "name": "restEquipmentPhysicalPortRequestResyncEfmOamEventLogs", "summary": "rest_equipment_PhysicalPort_requestResyncEfmOamEventLogs", "description": "rest_equipment_PhysicalPort_requestResyncEfmOamEventLogs", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentPhysicalPortRequestResyncEfmOamEventLogs" }, "task": true }, { "name": "restEquipmentPhysicalPortRequestResyncEfmOamEventStats", "summary": "rest_equipment_PhysicalPort_requestResyncEfmOamEventStats", "description": "rest_equipment_PhysicalPort_requestResyncEfmOamEventStats", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentPhysicalPortRequestResyncEfmOamEventStats" }, "task": true }, { "name": "restEquipmentPhysicalPortRequestResyncEfmOamPeerInfo", "summary": "rest_equipment_PhysicalPort_requestResyncEfmOamPeerInfo", "description": "rest_equipment_PhysicalPort_requestResyncEfmOamPeerInfo", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentPhysicalPortRequestResyncEfmOamPeerInfo" }, "task": true }, { "name": "restEquipmentPortGetMigrationResult", "summary": "getMigrationResult", "description": "Method to migrate port from Access to Hybrid mode. Intention : ACCESSOR getMigrationResult: class-level accessor API getMigrationResult of class equipment.Port DescendantInfo: opticalequipment.VtsChannel DescendantInfo: sonetequipment.Sts12Channel DescendantInfo: sonetequipment.Group DescendantInfo: opticalequipment.OpticalChannel DescendantInfo: bundle.ApsInterface DescendantInfo: lag.Interface DescendantInfo: equipment.Connector DescendantInfo: aps.ApsGroup DescendantInfo...(description truncated)", "input": [ { "name": "distinguishedName", "type": "string", "info": ": string", "required": false, "schema": { "title": "distinguishedName", "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": "/restEquipmentPortGetMigrationResult" }, "task": true }, { "name": "restEquipmentPortMigrateMode", "summary": "rest_equipment_Port_migrateMode", "description": "rest_equipment_Port_migrateMode", "input": [ { "name": "body", "type": "object", "info": ": {\"distinguishedName\": \"string\", \"portMode\": \"string\", \"configInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}}", "required": false, "schema": { "type": "object", "required": [ "configInfo", "distinguishedName", "portMode" ], "properties": { "distinguishedName": { "type": "string", "description": " Distinguished Name of Port LAG to be migrated." }, "portMode": { "type": "string", "description": " Desired Mode value" }, "configInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for Port.migrateMode to decode json data to internal NFM-P object model" } } ], "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": "/restEquipmentPortMigrateMode" }, "task": true }, { "name": "restEquipmentPortGroupFirmwareUpgrade", "summary": "rest_equipment_PortGroup_firmwareUpgrade", "description": "rest_equipment_PortGroup_firmwareUpgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentPortGroupFirmwareUpgrade" }, "task": true }, { "name": "restEquipmentPowerModuleRemovePowerModule", "summary": "removePowerModule", "description": "Intention : MODIFIER removePowerModule: instance-level [administrative deletion] (modifier) API removePowerModule of class equipment.PowerModule instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentPowerModuleRemovePowerModule" }, "task": true }, { "name": "restEquipmentPowerShelfRemovePowerShelf", "summary": "removePowerShelf", "description": "Intention : MODIFIER removePowerShelf: instance-level [administrative deletion] (modifier) API removePowerShelf of class equipment.PowerShelf instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentPowerShelfRemovePowerShelf" }, "task": true }, { "name": "restEquipmentPowerSupplyTrayRemovePowerSupply", "summary": "removePowerSupply", "description": "Intention : MODIFIER removePowerSupply: instance-level [administrative deletion] (modifier) API removePowerSupply of class equipment.PowerSupplyTray instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentPowerSupplyTrayRemovePowerSupply" }, "task": true }, { "name": "restEquipmentPwPortRequestClearSubVlanStats", "summary": "requestClearSubVlanStats", "description": "Request clearing of Subscriber VLAN statistics. Statistics will be for all service access points with the corresponding port id and outer encap value. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearSubVlanStats: class-level modifier API requestClearSubVlanStats of class equipment.PwPort A request handle which allows the retrieval of the request (and its r...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"portName\": \"string\", \"vlanId\": 123}", "required": false, "schema": { "type": "object", "required": [ "portName", "siteId", "vlanId" ], "properties": { "siteId": { "type": "string", "description": " Specifies Site ID of the Subscriber VLAN Statistics to be cleared.This is mandatory parameter." }, "portName": { "type": "string", "description": " Specifies port of the Subscriber VLAN Statistics to be cleared.This is mandatory parameter." }, "vlanId": { "type": "integer", "description": " Specifies VLAN ID the Subscriber VLAN Statistics to be cleared.This value is equal to the outer encapsulation value on the Service Access Point.If set to -1, all Subscriber VLAN Statistics on the specified port will be cleared. default:-1" } }, "description": "Model containing the method level model for PwPort.requestClearSubVlanStats to decode json data to internal NFM-P object model" } } ], "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": "/restEquipmentPwPortRequestClearSubVlanStats" }, "task": true }, { "name": "restEquipmentShelfDeleteShelf", "summary": "rest_equipment_Shelf_deleteShelf", "description": "rest_equipment_Shelf_deleteShelf", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentShelfDeleteShelf" }, "task": true }, { "name": "restEquipmentShelfFindApsGroups", "summary": "findApsGroups", "description": "Intention : RETRIEVER findApsGroups: instance-level [object finder] (retriever) API findApsGroups of class equipment.Shelf DescendantInfo: hip.EMSShelf instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restEquipmentShelfFindApsGroups" }, "task": true }, { "name": "restEquipmentShelfReboot", "summary": "rest_equipment_Shelf_reboot", "description": "rest_equipment_Shelf_reboot", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentShelfReboot" }, "task": true }, { "name": "restEquipmentShelfRebootWithFirmwareUpgrade", "summary": "rest_equipment_Shelf_rebootWithFirmwareUpgrade", "description": "rest_equipment_Shelf_rebootWithFirmwareUpgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentShelfRebootWithFirmwareUpgrade" }, "task": true }, { "name": "restEquipmentShelfRemoveShelf", "summary": "rest_equipment_Shelf_removeShelf", "description": "rest_equipment_Shelf_removeShelf", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentShelfRemoveShelf" }, "task": true }, { "name": "restEquipmentShelfSwitchToRedundantEC", "summary": "rest_equipment_Shelf_switchToRedundantEC", "description": "rest_equipment_Shelf_switchToRedundantEC", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentShelfSwitchToRedundantEC" }, "task": true }, { "name": "restEquipmentShelfSwitchovercmm", "summary": "rest_equipment_Shelf_switchovercmm", "description": "rest_equipment_Shelf_switchovercmm", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentShelfSwitchovercmm" }, "task": true }, { "name": "restEquipmentShelfVcTakeOver", "summary": "rest_equipment_Shelf_vcTakeOver", "description": "rest_equipment_Shelf_vcTakeOver", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEquipmentShelfVcTakeOver" }, "task": true }, { "name": "restEsaEsaVirtualMachineGetDependencyCount", "summary": "getDependencyCount", "description": "Intention : RETRIEVER getDependencyCount: instance-level retriever API getDependencyCount of class esa.EsaVirtualMachine instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEsaEsaVirtualMachineGetDependencyCount" }, "task": true }, { "name": "restEsaExtendedServicesApplianceGetDependencyCount", "summary": "getDependencyCount", "description": "Intention : RETRIEVER getDependencyCount: instance-level retriever API getDependencyCount of class esa.ExtendedServicesAppliance instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEsaExtendedServicesApplianceGetDependencyCount" }, "task": true }, { "name": "restEthernetequipmentHsmdaEgressSecondaryShaperConfigureSecondaryShapers", "summary": "configureSecondaryShapers", "description": "This method creates Secondary Shapers under multiple physical ports. Intention : MODIFIER configureSecondaryShapers: class-level [hierarchical administrative configuration/modification] (modifier) API configureSecondaryShapers of class ethernetequipment.HsmdaEgressSecondaryShaper This API follows hierarchical config model rules. Map of failed Hsmda Egress Secondary Shapers parent fullnames and Exceptions. Also one of the configured Hsmda Egress Secondary Shapers info objects", "input": [ { "name": "body", "type": "object", "info": ": {\"configInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}, \"parentFullNameList\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "configInfo", "parentFullNameList" ], "properties": { "configInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" }, "parentFullNameList": { "type": "array", "description": " The list of physical port full names.Hsmda Egress Secondary Shapers are created under this list of parent objects.", "items": { "type": "string" } } }, "description": "Model containing the method level model for HsmdaEgressSecondaryShaper.configureSecondaryShapers to decode json data to internal NFM-P object model" } } ], "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": "/restEthernetequipmentHsmdaEgressSecondaryShaperConfigureSecondaryShapers" }, "task": true }, { "name": "restEthernetoamAbstractAccessInterfaceMipResyncMip", "summary": "rest_ethernetoam_AbstractAccessInterfaceMip_resyncMip", "description": "rest_ethernetoam_AbstractAccessInterfaceMip_resyncMip", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthernetoamAbstractAccessInterfaceMipResyncMip" }, "task": true }, { "name": "restEthernetoamAbstractMipResync", "summary": "rest_ethernetoam_AbstractMip_resync", "description": "rest_ethernetoam_AbstractMip_resync", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restEthernetoamAbstractMipResync" }, "task": true }, { "name": "restEthernetoamAbstractSdpBindingMipResyncMip", "summary": "rest_ethernetoam_AbstractSdpBindingMip_resyncMip", "description": "rest_ethernetoam_AbstractSdpBindingMip_resyncMip", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthernetoamAbstractSdpBindingMipResyncMip" }, "task": true }, { "name": "restEthernetoamCcTestAuditUnicastCCM", "summary": "rest_ethernetoam_CcTest_auditUnicastCCM", "description": "rest_ethernetoam_CcTest_auditUnicastCCM", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthernetoamCcTestAuditUnicastCCM" }, "task": true }, { "name": "restEthernetoamCcTestDiscoverSubGroups", "summary": "rest_ethernetoam_CcTest_discoverSubGroups", "description": "rest_ethernetoam_CcTest_discoverSubGroups", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthernetoamCcTestDiscoverSubGroups" }, "task": true }, { "name": "restEthernetoamCcTestDiscoverSubGroupsByDomainId", "summary": "rest_ethernetoam_CcTest_discoverSubGroupsByDomainId", "description": "rest_ethernetoam_CcTest_discoverSubGroupsByDomainId", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthernetoamCcTestDiscoverSubGroupsByDomainId" }, "task": true }, { "name": "restEthernetoamCcTestResyncRemoteMepDb", "summary": "rest_ethernetoam_CcTest_resyncRemoteMepDb", "description": "rest_ethernetoam_CcTest_resyncRemoteMepDb", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthernetoamCcTestResyncRemoteMepDb" }, "task": true }, { "name": "restEthernetoamCcTestSynchronizeMeps", "summary": "rest_ethernetoam_CcTest_synchronizeMeps", "description": "rest_ethernetoam_CcTest_synchronizeMeps", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthernetoamCcTestSynchronizeMeps" }, "task": true }, { "name": "restEthernetoamCcmTestCancelCcmTest", "summary": "rest_ethernetoam_CcmTest_cancelCcmTest", "description": "rest_ethernetoam_CcmTest_cancelCcmTest", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthernetoamCcmTestCancelCcmTest" }, "task": true }, { "name": "restEthernetoamCfmDmmSessionRequestClearOamPmDmmRawStats", "summary": "requestClearOamPmDmmRawStats", "description": "Request clearing of Oam Pm Raw Stats. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearOamPmDmmRawStats: instance-level modifier API requestClearOamPmDmmRawStats of class ethernetoam.CfmDmmSession instanceFullName : distinguished/instance name of c...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthernetoamCfmDmmSessionRequestClearOamPmDmmRawStats" }, "task": true }, { "name": "restEthernetoamCfmLMTestStopCfmlm", "summary": "rest_ethernetoam_CfmLMTest_stopCfmlm", "description": "rest_ethernetoam_CfmLMTest_stopCfmlm", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthernetoamCfmLMTestStopCfmlm" }, "task": true }, { "name": "restEthernetoamCfmLmmSessionRequestClearOamPmLmmRawStats", "summary": "requestClearOamPmLmmRawStats", "description": "Request clearing of OAM PM Raw Stats. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearOamPmLmmRawStats: instance-level modifier API requestClearOamPmLmmRawStats of class ethernetoam.CfmLmmSession instanceFullName : distinguished/instance name of c...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthernetoamCfmLmmSessionRequestClearOamPmLmmRawStats" }, "task": true }, { "name": "restEthernetoamCfmLoopbackStopCfmLoopBackTest", "summary": "rest_ethernetoam_CfmLoopback_stopCfmLoopBackTest", "description": "rest_ethernetoam_CfmLoopback_stopCfmLoopBackTest", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthernetoamCfmLoopbackStopCfmLoopBackTest" }, "task": true }, { "name": "restEthernetoamCfmSlmSessionRequestClearOamPmSlmRawStats", "summary": "requestClearOamPmSlmRawStats", "description": "Request clearing of OAM PM Raw Stats. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearOamPmSlmRawStats: instance-level modifier API requestClearOamPmSlmRawStats of class ethernetoam.CfmSlmSession instanceFullName : distinguished/instance name of c...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthernetoamCfmSlmSessionRequestClearOamPmSlmRawStats" }, "task": true }, { "name": "restEthernetoamCfmTwoWayDelayTestStopCfmTwoWayDelayTest", "summary": "rest_ethernetoam_CfmTwoWayDelayTest_stopCfmTwoWayDelayTest", "description": "rest_ethernetoam_CfmTwoWayDelayTest_stopCfmTwoWayDelayTest", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthernetoamCfmTwoWayDelayTestStopCfmTwoWayDelayTest" }, "task": true }, { "name": "restEthernetoamCfmTwoWaySlmStopCfmTwoWaySlm", "summary": "rest_ethernetoam_CfmTwoWaySlm_stopCfmTwoWaySlm", "description": "rest_ethernetoam_CfmTwoWaySlm_stopCfmTwoWaySlm", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthernetoamCfmTwoWaySlmStopCfmTwoWaySlm" }, "task": true }, { "name": "restEthernetoamMaintAssociationClearAutoDiscoveredRemoteMep", "summary": "rest_ethernetoam_MaintAssociation_clearAutoDiscoveredRemoteMep", "description": "rest_ethernetoam_MaintAssociation_clearAutoDiscoveredRemoteMep", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthernetoamMaintAssociationClearAutoDiscoveredRemoteMep" }, "task": true }, { "name": "restEthernetoamMepResyncRemoteMepDb", "summary": "rest_ethernetoam_Mep_resyncRemoteMepDb", "description": "rest_ethernetoam_Mep_resyncRemoteMepDb", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthernetoamMepResyncRemoteMepDb" }, "task": true }, { "name": "restEthernettunnelEthPathComponentRenum", "summary": "rest_ethernettunnel_EthPathComponent_renum", "description": "rest_ethernettunnel_EthPathComponent_renum", "input": [ { "name": "body", "type": "object", "info": ": {\"aInNewEntryFullName\": \"string\", \"aInOldEntryFullName\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInNewEntryFullName": { "type": "string" }, "aInOldEntryFullName": { "type": "string" } }, "description": "Model containing the method level model for SecurityPolicyEntryDefinition.renum to decode json data to internal NFM-P object model" } } ], "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": "/restEthernettunnelEthPathComponentRenum" }, "task": true }, { "name": "restEthernettunnelEthernetPathCreateMEPs", "summary": "rest_ethernettunnel_EthernetPath_createMEPs", "description": "rest_ethernettunnel_EthernetPath_createMEPs", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthernettunnelEthernetPathCreateMEPs" }, "task": true }, { "name": "restEthernettunnelEthernetPathDeleteEthernetPath", "summary": "rest_ethernettunnel_EthernetPath_deleteEthernetPath", "description": "rest_ethernettunnel_EthernetPath_deleteEthernetPath", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restEthernettunnelEthernetPathDeleteEthernetPath" }, "task": true }, { "name": "restEthernettunnelEthernetPathExecuteCCProtocol", "summary": "rest_ethernettunnel_EthernetPath_executeCCProtocol", "description": "rest_ethernettunnel_EthernetPath_executeCCProtocol", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthernettunnelEthernetPathExecuteCCProtocol" }, "task": true }, { "name": "restEthernettunnelEthernetTunnelAddEthernetTunnelEndpoint", "summary": "rest_ethernettunnel_EthernetTunnel_addEthernetTunnelEndpoint", "description": "rest_ethernettunnel_EthernetTunnel_addEthernetTunnelEndpoint", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restEthernettunnelEthernetTunnelAddEthernetTunnelEndpoint" }, "task": true }, { "name": "restEthernettunnelEthernetTunnelCreateEthernetTunnelEndpoint", "summary": "createEthernetTunnelEndpoint", "description": "creates a EthernetTunnelEndpoint and it add the endpoint to this Ethernet Tunnel Intention : MODIFIER createEthernetTunnelEndpoint: instance-level [administrative creation] (modifier) API createEthernetTunnelEndpoint of class ethernettunnel.EthernetTunnel instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"administrativeState\": 123, \"oesShelfId\": 123, \"phyShelfClass\": 123, \"phyShelfType\": 123, \"lockOlcState\": \"boolean\", \"portId\": 123, \"description\": \"string\", \"mode\": 123, \"isl2UplinkMode\": \"boolean\", \"macAddress\": \"string\", \"encapType\": 123, \"holdTimeUp\": 123, \"holdTimeDown\": 123, \"mtuValue\": 123, \"speed\": 123, \"accountingPolicyObjectPointer\": \"string\", \"collectStats\": \"boolean\", \"etherAccountingPolicyObjectPointer\": \"string\", \"etherCollectStats\": \"boolean\", \"ethAccessAccountingPolicyObjectPointer\": \"string\", \"ethAccessCollectStats\": \"boolean\", \"networkQueueObjectPointer\": \"string\", \"loadBalanceAlgorithm\": 123, \"portSchedulerPolicyObjectPointer\": \"string\", \"portEgrHsmdaSchedulerPolicy\": \"string\", \"uniProfilePointer\": \"string\", \"portIngrNamedPoolPlcy\": \"string\", \"portEgrNamedPoolPlcy\": \"string\", \"portIngrPoolPercentageRate\": 123, \"portEgrPoolPercentageRate\": 123, \"vlanAutoBind\": \"boolean\", \"l2ProfilePointer\": \"string\", \"holdTimeUnits\": 123, \"linkTrap\": 123, \"userLabel\": \"string\", \"mptCombinerImplemented\": 123, \"numOfDot1qSapUsingVCP\": 123, \"isVCPUpdatedForDot1qSap\": \"boolean\", \"isVCPSapPort\": \"boolean\", \"unpPortType\": 123, \"tunnelEndpointId\": 123, \"endPointSiteIdAddrType\": 123, \"endPointSiteId\": \"string\", \"protectionType\": 123, \"revertTime\": 123, \"accessAdaptQos\": 123, \"perFpIngQueuing\": \"boolean\", \"pathThreshold\": 123}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "administrativeState": { "type": "integer" }, "oesShelfId": { "type": "integer" }, "phyShelfClass": { "type": "integer" }, "phyShelfType": { "type": "integer" }, "lockOlcState": { "type": "boolean", "default": false }, "portId": { "type": "integer" }, "description": { "type": "string" }, "mode": { "type": "integer" }, "isl2UplinkMode": { "type": "boolean", "default": false }, "macAddress": { "type": "string" }, "encapType": { "type": "integer" }, "holdTimeUp": { "type": "integer" }, "holdTimeDown": { "type": "integer" }, "mtuValue": { "type": "integer" }, "speed": { "type": "integer" }, "accountingPolicyObjectPointer": { "type": "string" }, "collectStats": { "type": "boolean", "default": false }, "etherAccountingPolicyObjectPointer": { "type": "string" }, "etherCollectStats": { "type": "boolean", "default": false }, "ethAccessAccountingPolicyObjectPointer": { "type": "string" }, "ethAccessCollectStats": { "type": "boolean", "default": false }, "networkQueueObjectPointer": { "type": "string" }, "loadBalanceAlgorithm": { "type": "integer" }, "portSchedulerPolicyObjectPointer": { "type": "string" }, "portEgrHsmdaSchedulerPolicy": { "type": "string" }, "uniProfilePointer": { "type": "string" }, "portIngrNamedPoolPlcy": { "type": "string" }, "portEgrNamedPoolPlcy": { "type": "string" }, "portIngrPoolPercentageRate": { "type": "integer" }, "portEgrPoolPercentageRate": { "type": "integer" }, "vlanAutoBind": { "type": "boolean", "default": false }, "l2ProfilePointer": { "type": "string" }, "holdTimeUnits": { "type": "integer" }, "linkTrap": { "type": "integer" }, "userLabel": { "type": "string" }, "mptCombinerImplemented": { "type": "integer" }, "numOfDot1qSapUsingVCP": { "type": "integer" }, "isVCPUpdatedForDot1qSap": { "type": "boolean", "default": false }, "isVCPSapPort": { "type": "boolean", "default": false }, "unpPortType": { "type": "integer" }, "tunnelEndpointId": { "type": "integer" }, "endPointSiteIdAddrType": { "type": "integer" }, "endPointSiteId": { "type": "string" }, "protectionType": { "type": "integer" }, "revertTime": { "type": "integer" }, "accessAdaptQos": { "type": "integer" }, "perFpIngQueuing": { "type": "boolean", "default": false }, "pathThreshold": { "type": "integer" } }, "description": "Model containing the method level model for Interface ConfigInfo EthernetTunnelEndpointConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restEthernettunnelEthernetTunnelCreateEthernetTunnelEndpoint" }, "task": true }, { "name": "restEthernettunnelEthernetTunnelRemoveEthernetTunnelEndpoint", "summary": "rest_ethernettunnel_EthernetTunnel_removeEthernetTunnelEndpoint", "description": "rest_ethernettunnel_EthernetTunnel_removeEthernetTunnelEndpoint", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restEthernettunnelEthernetTunnelRemoveEthernetTunnelEndpoint" }, "task": true }, { "name": "restEthernettunnelEthernetTunnelPathEndpointFindCtpsForTunnelPathEndpoint", "summary": "findCtpsForTunnelPathEndpoint", "description": "Intention : RETRIEVER findCtpsForTunnelPathEndpoint: class-level [object finder] (retriever) API findCtpsForTunnelPathEndpoint of class ethernettunnel.EthernetTunnelPathEndpoint", "input": [ { "name": "body", "type": "object", "info": ": {\"nodeId\": \"string\", \"ctpFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "ctpFilter", "nodeId" ], "properties": { "nodeId": { "type": "string", "description": " " }, "ctpFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for EthernetTunnelPathEndpoint.findCtpsForTunnelPathEndpoint to decode json data to internal NFM-P object model" } } ], "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": "/restEthernettunnelEthernetTunnelPathEndpointFindCtpsForTunnelPathEndpoint" }, "task": true }, { "name": "restEthringInterconnectDeleteInterconnect", "summary": "rest_ethring_Interconnect_deleteInterconnect", "description": "rest_ethring_Interconnect_deleteInterconnect", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restEthringInterconnectDeleteInterconnect" }, "task": true }, { "name": "restEthringPathCreateMEPs", "summary": "rest_ethring_Path_createMEPs", "description": "rest_ethring_Path_createMEPs", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthringPathCreateMEPs" }, "task": true }, { "name": "restEthringPathDeleteEthernetPath", "summary": "rest_ethring_Path_deleteEthernetPath", "description": "rest_ethring_Path_deleteEthernetPath", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restEthringPathDeleteEthernetPath" }, "task": true }, { "name": "restEthringPathExecuteCCProtocol", "summary": "rest_ethring_Path_executeCCProtocol", "description": "rest_ethring_Path_executeCCProtocol", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthringPathExecuteCCProtocol" }, "task": true }, { "name": "restEthringPathEndpointFindCtpsForPathEndpoint", "summary": "findCtpsForPathEndpoint", "description": "Intention : RETRIEVER findCtpsForPathEndpoint: class-level [object finder] (retriever) API findCtpsForPathEndpoint of class ethring.PathEndpoint", "input": [ { "name": "body", "type": "object", "info": ": {\"siteIdSet\": \"array\", \"ctpFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "ctpFilter", "siteIdSet" ], "properties": { "siteIdSet": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "ctpFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for PathEndpoint.findCtpsForPathEndpoint to decode json data to internal NFM-P object model" } } ], "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": "/restEthringPathEndpointFindCtpsForPathEndpoint" }, "task": true }, { "name": "restEthringRadioRingAddElement", "summary": "rest_ethring_RadioRing_addElement", "description": "rest_ethring_RadioRing_addElement", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restEthringRadioRingAddElement" }, "task": true }, { "name": "restEthringRadioRingCreateElement", "summary": "createElement", "description": "Creates an Ethernet Ring Element and adds it to this Ethernet Ring. Intention : MODIFIER createElement: instance-level [administrative creation] (modifier) API createElement of class ethring.RadioRing instanceFullName : distinguished/instance name of called object Resulting objects list.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restEthringRadioRingCreateElement" }, "task": true }, { "name": "restEthringRadioRingRemoveElement", "summary": "rest_ethring_RadioRing_removeElement", "description": "rest_ethring_RadioRing_removeElement", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restEthringRadioRingRemoveElement" }, "task": true }, { "name": "restEthringRingAddElement", "summary": "rest_ethring_Ring_addElement", "description": "rest_ethring_Ring_addElement", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restEthringRingAddElement" }, "task": true }, { "name": "restEthringRingCcmStartAll", "summary": "rest_ethring_Ring_ccmStartAll", "description": "rest_ethring_Ring_ccmStartAll", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthringRingCcmStartAll" }, "task": true }, { "name": "restEthringRingCcmStopAll", "summary": "rest_ethring_Ring_ccmStopAll", "description": "rest_ethring_Ring_ccmStopAll", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthringRingCcmStopAll" }, "task": true }, { "name": "restEthringRingCreateControlService", "summary": "createControlService", "description": "Creates the Control Service for this Ethernet Ring using the parameters specified. Intention : MODIFIER createControlService: instance-level [administrative creation] (modifier) API createControlService of class ethring.Ring instanceFullName : distinguished/instance name of called object The FDN of the resulting Control Service.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInCustomerFdn\": \"string\", \"aInControlServiceTemplateFdn\": \"string\", \"aInUpperRingOuterEncap\": 123, \"aInUpperRingInnerEncap\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInCustomerFdn": { "type": "string" }, "aInControlServiceTemplateFdn": { "type": "string" }, "aInUpperRingOuterEncap": { "type": "integer" }, "aInUpperRingInnerEncap": { "type": "integer" } }, "description": "Model containing the method level model for Ring.createControlService to decode json data to internal NFM-P object model" } } ], "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": "/restEthringRingCreateControlService" }, "task": true }, { "name": "restEthringRingCreateDataService", "summary": "createDataService", "description": "Creates the Data Service for this Ethernet Ring using the parameters specified. Intention : MODIFIER createDataService: instance-level [administrative creation] (modifier) API createDataService of class ethring.Ring instanceFullName : distinguished/instance name of called object The FDN of the resulting Data Service.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInCustomerFdn\": \"string\", \"aInDataServiceTemplateFdn\": \"string\", \"aInExistingDataServiceFdn\": \"string\", \"aInDataServiceOuterEncap\": 123, \"aInDataServiceInnerEncap\": 123, \"aInSiteIds\": \"array\"}", "required": false, "schema": { "type": "object", "properties": { "aInCustomerFdn": { "type": "string" }, "aInDataServiceTemplateFdn": { "type": "string" }, "aInExistingDataServiceFdn": { "type": "string" }, "aInDataServiceOuterEncap": { "type": "integer" }, "aInDataServiceInnerEncap": { "type": "integer" }, "aInSiteIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for Ring.createDataService to decode json data to internal NFM-P object model" } } ], "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": "/restEthringRingCreateDataService" }, "task": true }, { "name": "restEthringRingCreateDataServicePathSearch", "summary": "createDataServicePathSearch", "description": "Creates the Data Service for this Ethernet Ring using the parameters specified. Intention : MODIFIER createDataServicePathSearch: class-level [administrative creation] (modifier) API createDataServicePathSearch of class ethring.Ring The FDN of the resulting Data Service.", "input": [ { "name": "body", "type": "object", "info": ": {\"aInDataServiceTemplateFdn\": \"string\", \"aInExistingDataServiceFdn\": \"string\", \"aInDataServiceOuterEncap\": 123, \"aInDataServiceInnerEncap\": 123, \"aInSiteIds\": \"array\", \"aInTspFdn\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInDataServiceTemplateFdn": { "type": "string" }, "aInExistingDataServiceFdn": { "type": "string" }, "aInDataServiceOuterEncap": { "type": "integer" }, "aInDataServiceInnerEncap": { "type": "integer" }, "aInSiteIds": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "aInTspFdn": { "type": "string" } }, "description": "Model containing the method level model for Ring.createDataServicePathSearch to decode json data to internal NFM-P object model" } } ], "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": "/restEthringRingCreateDataServicePathSearch" }, "task": true }, { "name": "restEthringRingCreateElement", "summary": "createElement", "description": "Creates an Ethernet Ring Element and adds it to this Ethernet Ring. Intention : MODIFIER createElement: instance-level [administrative creation] (modifier) API createElement of class ethring.Ring instanceFullName : distinguished/instance name of called object Resulting objects list.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInElementList\": [{\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\"}], \"autoConfigureMissingControlServices\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "autoConfigureMissingControlServices" ], "properties": { "aInElementList": { "type": "array", "items": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "autoConfigureMissingControlServices": { "type": "boolean", "description": " This parameter is applicable only if the ring element type is aos. If set to true, the VLAN service sites and the access interfaces NNIbindings are automatically configured ports used as path endpoints. default:false", "default": false } }, "description": "Model containing the method level model for Ring.createElement to decode json data to internal NFM-P object model" } } ], "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": "/restEthringRingCreateElement" }, "task": true }, { "name": "restEthringRingCreateTransitService", "summary": "createTransitService", "description": "Creates the Transit Service for this Ethernet Ring using the parameters specified. Intention : MODIFIER createTransitService: instance-level [administrative creation] (modifier) API createTransitService of class ethring.Ring instanceFullName : distinguished/instance name of called object The FDN of the resulting Transit Service.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInCustomerFdn\": \"string\", \"aInDataServiceOuterEncap\": 123, \"aInDataServiceInnerEncap\": 123, \"aInControlServiceTemplateFdn\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInCustomerFdn": { "type": "string" }, "aInDataServiceOuterEncap": { "type": "integer" }, "aInDataServiceInnerEncap": { "type": "integer" }, "aInControlServiceTemplateFdn": { "type": "string" } }, "description": "Model containing the method level model for Ring.createTransitService to decode json data to internal NFM-P object model" } } ], "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": "/restEthringRingCreateTransitService" }, "task": true }, { "name": "restEthringRingGlobalRingAuditCheck", "summary": "globalRingAuditCheck", "description": "Checks to see if all ethernet rings appear to be fully configured (based on number of elements, paths, interconnects, path endpoints, and operational flags of the ring). Intention : RETRIEVER globalRingAuditCheck: class-level retriever API globalRingAuditCheck of class ethring.Ring The result of the global ring audit.", "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": "/restEthringRingGlobalRingAuditCheck" }, "task": true }, { "name": "restEthringRingRemoveElement", "summary": "rest_ethring_Ring_removeElement", "description": "rest_ethring_Ring_removeElement", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restEthringRingRemoveElement" }, "task": true }, { "name": "restEthringRingRingAuditCheck", "summary": "ringAuditCheck", "description": "Checks to see if the ethernet ring appears to be fully configured (based on number of elements, paths, interconnects, path endpoints, and operational flags of the ring). Intention : RETRIEVER ringAuditCheck: instance-level retriever API ringAuditCheck of class ethring.Ring instanceFullName : distinguished/instance name of called object The result of the ring audit.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthringRingRingAuditCheck" }, "task": true }, { "name": "restEthringRingUpdateDataServices", "summary": "updateDataServices", "description": "Update all data services associated with this ring, allowing for cut-in cut-out Intention : MODIFIER updateDataServices: instance-level modifier API updateDataServices of class ethring.Ring instanceFullName : distinguished/instance name of called object Returns number of data services updated.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restEthringRingUpdateDataServices" }, "task": true }, { "name": "restEventEventPolicyPurge", "summary": "rest_event_EventPolicy_purge", "description": "rest_event_EventPolicy_purge", "input": [ { "name": "body", "type": "object", "info": ": {\"logEntityType\": \"string\", \"className\": \"string\", \"purgeType\": \"string\", \"recordFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "className", "logEntityType", "purgeType", "recordFilter" ], "properties": { "logEntityType": { "type": "string", "description": " Type of record to be purged." }, "className": { "type": "string", "description": " Class name of the records to be purged." }, "purgeType": { "type": "string", "description": " Not used." }, "recordFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for LogPolicy.purge to decode json data to internal NFM-P object model" } } ], "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": "/restEventEventPolicyPurge" }, "task": true }, { "name": "restFileLogDefinitionFindFiles", "summary": "findFiles", "description": "Intention : RETRIEVER findFiles: instance-level [object finder] (retriever) API findFiles of class file.LogDefinition DescendantInfo: accounting.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restFileLogDefinitionFindFiles" }, "task": true }, { "name": "restFilePolicyFindAccessInterfaces", "summary": "findAccessInterfaces", "description": "Intention : RETRIEVER findAccessInterfaces: instance-level [object finder] (retriever) API findAccessInterfaces of class file.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restFilePolicyFindAccessInterfaces" }, "task": true }, { "name": "restFilePolicyFindLogPolicy", "summary": "findLogPolicy", "description": "Intention : RETRIEVER findLogPolicy: instance-level [object finder] (retriever) API findLogPolicy of class file.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restFilePolicyFindLogPolicy" }, "task": true }, { "name": "restFilePolicyFindNetworkInterfaces", "summary": "findNetworkInterfaces", "description": "Intention : RETRIEVER findNetworkInterfaces: instance-level [object finder] (retriever) API findNetworkInterfaces of class file.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restFilePolicyFindNetworkInterfaces" }, "task": true }, { "name": "restFilePolicyFindPorts", "summary": "findPorts", "description": "Intention : RETRIEVER findPorts: instance-level [object finder] (retriever) API findPorts of class file.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restFilePolicyFindPorts" }, "task": true }, { "name": "restFilePolicyFindSdpBindings", "summary": "findSdpBindings", "description": "Intention : RETRIEVER findSdpBindings: instance-level [object finder] (retriever) API findSdpBindings of class file.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restFilePolicyFindSdpBindings" }, "task": true }, { "name": "restFilePolicyFindSdpTunnels", "summary": "findSdpTunnels", "description": "Intention : RETRIEVER findSdpTunnels: instance-level [object finder] (retriever) API findSdpTunnels of class file.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restFilePolicyFindSdpTunnels" }, "task": true }, { "name": "restFilePolicyFindServiceIpInterfaces", "summary": "findServiceIpInterfaces", "description": "Intention : RETRIEVER findServiceIpInterfaces: instance-level [object finder] (retriever) API findServiceIpInterfaces of class file.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restFilePolicyFindServiceIpInterfaces" }, "task": true }, { "name": "restFirewallFwEntryDefinitionRenum", "summary": "rest_firewall_FwEntryDefinition_renum", "description": "rest_firewall_FwEntryDefinition_renum", "input": [ { "name": "body", "type": "object", "info": ": {\"aInNewEntryFullName\": \"string\", \"aInOldEntryFullName\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInNewEntryFullName": { "type": "string" }, "aInOldEntryFullName": { "type": "string" } }, "description": "Model containing the method level model for SecurityPolicyEntryDefinition.renum to decode json data to internal NFM-P object model" } } ], "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": "/restFirewallFwEntryDefinitionRenum" }, "task": true }, { "name": "restFirewallFwPolicyDefinitionFindAssociations", "summary": "findAssociations", "description": "Intention : RETRIEVER findAssociations: class-level [object finder] (retriever) API findAssociations of class firewall.FwPolicyDefinition DescendantInfo: firewall.HostGroup DescendantInfo: firewall.Zone DescendantInfo: firewall.RuleSet DescendantInfo: firewall.ServiceGroup", "input": [ { "name": "body", "type": "object", "info": ": {\"aInPolicyEntryClass\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter" ], "properties": { "aInPolicyEntryClass": { "type": "string" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for FwPolicyDefinition.findAssociations to decode json data to internal NFM-P object model" } } ], "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": "/restFirewallFwPolicyDefinitionFindAssociations" }, "task": true }, { "name": "restFirewallFwPolicyDefinitionFindGlobalPoliciesForDistribution", "summary": "findGlobalPoliciesForDistribution", "description": "Intention : RETRIEVER findGlobalPoliciesForDistribution: class-level [object finder] (retriever) API findGlobalPoliciesForDistribution of class firewall.FwPolicyDefinition DescendantInfo: firewall.HostGroup DescendantInfo: firewall.Zone DescendantInfo: firewall.RuleSet DescendantInfo: firewall.ServiceGroup", "input": [ { "name": "aInSiteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInSiteId", "type": "string" } }, { "name": "aInClassName", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInClassName", "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": "/restFirewallFwPolicyDefinitionFindGlobalPoliciesForDistribution" }, "task": true }, { "name": "restFirewallFwPolicyDefinitionFindZoneAssociations", "summary": "findZoneAssociations", "description": "Intention : RETRIEVER findZoneAssociations: class-level [object finder] (retriever) API findZoneAssociations of class firewall.FwPolicyDefinition DescendantInfo: firewall.HostGroup DescendantInfo: firewall.Zone DescendantInfo: firewall.RuleSet DescendantInfo: firewall.ServiceGroup", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restFirewallFwPolicyDefinitionFindZoneAssociations" }, "task": true }, { "name": "restFlexiAbstractMRBTSBtsResetToTest", "summary": "rest_flexi_AbstractMRBTS_btsResetToTest", "description": "rest_flexi_AbstractMRBTS_btsResetToTest", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restFlexiAbstractMRBTSBtsResetToTest" }, "task": true }, { "name": "restFlexiAbstractMRBTSBtsSwReset", "summary": "rest_flexi_AbstractMRBTS_btsSwReset", "description": "rest_flexi_AbstractMRBTS_btsSwReset", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restFlexiAbstractMRBTSBtsSwReset" }, "task": true }, { "name": "restFlexiAbstractMRBTSChangeLocalUserPassword", "summary": "rest_flexi_AbstractMRBTS_changeLocalUserPassword", "description": "rest_flexi_AbstractMRBTS_changeLocalUserPassword", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"role\": \"string\", \"login\": \"string\", \"password\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "login", "password", "role" ], "properties": { "role": { "type": "string", "description": " default:1" }, "login": { "type": "string", "description": " " }, "password": { "type": "string", "description": " " } }, "description": "Model containing the method level model for AbstractMRBTS.changeLocalUserPassword to decode json data to internal NFM-P object model" } } ], "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": "/restFlexiAbstractMRBTSChangeLocalUserPassword" }, "task": true }, { "name": "restFlexiAbstractMRBTSChangeMediationCredentials", "summary": "rest_flexi_AbstractMRBTS_changeMediationCredentials", "description": "rest_flexi_AbstractMRBTS_changeMediationCredentials", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restFlexiAbstractMRBTSChangeMediationCredentials" }, "task": true }, { "name": "restFlexiAbstractMRBTSConfigureCertificateManagementAuthParameters", "summary": "rest_flexi_AbstractMRBTS_configureCertificateManagementAuthParameters", "description": "rest_flexi_AbstractMRBTS_configureCertificateManagementAuthParameters", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"preSharedKey\": \"string\", \"refNum\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "preSharedKey", "refNum" ], "properties": { "preSharedKey": { "type": "string", "description": " " }, "refNum": { "type": "string", "description": " " } }, "description": "Model containing the method level model for AbstractMRBTS.configureCertificateManagementAuthParameters to decode json data to internal NFM-P object model" } } ], "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": "/restFlexiAbstractMRBTSConfigureCertificateManagementAuthParameters" }, "task": true }, { "name": "restFlexiAbstractMRBTSHwResync", "summary": "rest_flexi_AbstractMRBTS_hwResync", "description": "rest_flexi_AbstractMRBTS_hwResync", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restFlexiAbstractMRBTSHwResync" }, "task": true }, { "name": "restFlexiAbstractMRBTSInitializeCertificateManagement", "summary": "rest_flexi_AbstractMRBTS_initializeCertificateManagement", "description": "rest_flexi_AbstractMRBTS_initializeCertificateManagement", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restFlexiAbstractMRBTSInitializeCertificateManagement" }, "task": true }, { "name": "restFlexiAbstractMRBTSLaunchRFDiagnostics", "summary": "rest_flexi_AbstractMRBTS_launchRFDiagnostics", "description": "rest_flexi_AbstractMRBTS_launchRFDiagnostics", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restFlexiAbstractMRBTSLaunchRFDiagnostics" }, "task": true }, { "name": "restFlexiAbstractMRBTSRequestCertificateManagementKeyUpdate", "summary": "rest_flexi_AbstractMRBTS_requestCertificateManagementKeyUpdate", "description": "rest_flexi_AbstractMRBTS_requestCertificateManagementKeyUpdate", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restFlexiAbstractMRBTSRequestCertificateManagementKeyUpdate" }, "task": true }, { "name": "restFlexiEquipmentStatesSpecificsLock", "summary": "rest_flexi_EquipmentStatesSpecifics_lock", "description": "rest_flexi_EquipmentStatesSpecifics_lock", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restFlexiEquipmentStatesSpecificsLock" }, "task": true }, { "name": "restFlexiEquipmentStatesSpecificsReset", "summary": "rest_flexi_EquipmentStatesSpecifics_reset", "description": "rest_flexi_EquipmentStatesSpecifics_reset", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restFlexiEquipmentStatesSpecificsReset" }, "task": true }, { "name": "restFlexiEquipmentStatesSpecificsShutdown", "summary": "rest_flexi_EquipmentStatesSpecifics_shutdown", "description": "rest_flexi_EquipmentStatesSpecifics_shutdown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restFlexiEquipmentStatesSpecificsShutdown" }, "task": true }, { "name": "restFlexiEquipmentStatesSpecificsUnlock", "summary": "rest_flexi_EquipmentStatesSpecifics_unlock", "description": "rest_flexi_EquipmentStatesSpecifics_unlock", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restFlexiEquipmentStatesSpecificsUnlock" }, "task": true }, { "name": "restFlexiProcessingBaseConfigureAtomicList", "summary": "rest_flexi_ProcessingBase_configureAtomicList", "description": "rest_flexi_ProcessingBase_configureAtomicList", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"listClassName\": \"string\", \"configInfoList\": [{\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\"}]}", "required": false, "schema": { "type": "object", "required": [ "configInfoList", "listClassName" ], "properties": { "listClassName": { "type": "string", "description": " Classname of the atomic list to configure." }, "configInfoList": { "type": "array", "description": " List of configInfo.", "items": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for ProcessingBase.configureAtomicList to decode json data to internal NFM-P object model" } } ], "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": "/restFlexiProcessingBaseConfigureAtomicList" }, "task": true }, { "name": "restFlexigrpFlexiTopologyGroupManagerCreateTopologyGroup", "summary": "rest_flexigrp_FlexiTopologyGroupManager_createTopologyGroup", "description": "rest_flexigrp_FlexiTopologyGroupManager_createTopologyGroup", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restFlexigrpFlexiTopologyGroupManagerCreateTopologyGroup" }, "task": true }, { "name": "restFlexigrpFlexiTopologyGroupManagerRegroupNEsInTopologyGroup", "summary": "rest_flexigrp_FlexiTopologyGroupManager_regroupNEsInTopologyGroup", "description": "rest_flexigrp_FlexiTopologyGroupManager_regroupNEsInTopologyGroup", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restFlexigrpFlexiTopologyGroupManagerRegroupNEsInTopologyGroup" }, "task": true }, { "name": "restFlexiperfFlexiPMPolicyFindFlexiNodes", "summary": "findFlexiNodes", "description": "Find all managed Flexi eNodeBs for the specified Performance Management polling policy assigned. Intention : RETRIEVER findFlexiNodes: class-level [object finder] (retriever) API findFlexiNodes of class flexiperf.FlexiPMPolicy DescendantInfo: flexiperf.FlexiNodePMPolicy", "input": [ { "name": "policyId", "type": "number", "info": ": 123", "required": false, "schema": { "title": "policyId", "type": "number" } } ], "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": "/restFlexiperfFlexiPMPolicyFindFlexiNodes" }, "task": true }, { "name": "restFlexiperfFlexiPMPolicyInvokeCatchup", "summary": "rest_flexiperf_FlexiPMPolicy_invokeCatchup", "description": "rest_flexiperf_FlexiPMPolicy_invokeCatchup", "input": [ { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restFlexiperfFlexiPMPolicyInvokeCatchup" }, "task": true }, { "name": "restFlexiperfFlexiPMPolicyInvokeFlexisCatchup", "summary": "rest_flexiperf_FlexiPMPolicy_invokeFlexisCatchup", "description": "rest_flexiperf_FlexiPMPolicy_invokeFlexisCatchup", "input": [ { "name": "body", "type": "object", "info": ": {\"networkElements\": \"array\", \"forceOnPMPolicyDown\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "forceOnPMPolicyDown", "networkElements" ], "properties": { "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "forceOnPMPolicyDown": { "type": "boolean", "description": " default:false", "default": false } }, "description": "Model containing the method level model for FlexiPMPolicy.invokeFlexisCatchup to decode json data to internal NFM-P object model" } } ], "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": "/restFlexiperfFlexiPMPolicyInvokeFlexisCatchup" }, "task": true }, { "name": "restFmAdditionalTextPolicyConfigureAdditionalTextPolicy", "summary": "configureAdditionalTextPolicy", "description": "Configure additional text policy Intention : MODIFIER configureAdditionalTextPolicy: class-level [hierarchical administrative configuration/modification] (modifier) API configureAdditionalTextPolicy of class fm.AdditionalTextPolicy This API follows hierarchical config model rules. Returns the full name of the additional text attribute instance", "input": [ { "name": "body", "type": "object", "info": ": {\"domain\": \"string\", \"objectType\": \"string\", \"additionalTextAttributeConfigInfo\": [{\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\"}]}", "required": false, "schema": { "type": "object", "required": [ "additionalTextAttributeConfigInfo", "domain", "objectType" ], "properties": { "domain": { "type": "string", "description": " The domain of the additional text policy" }, "objectType": { "type": "string", "description": " The object type of the additional text policy" }, "additionalTextAttributeConfigInfo": { "type": "array", "description": " The additional text attribute config info", "items": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for AdditionalTextPolicy.configureAdditionalTextPolicy to decode json data to internal NFM-P object model" } } ], "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": "/restFmAdditionalTextPolicyConfigureAdditionalTextPolicy" }, "task": true }, { "name": "restFmAlarmHistoryDatabaseConfigure", "summary": "rest_fm_AlarmHistoryDatabase_configure", "description": "rest_fm_AlarmHistoryDatabase_configure", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"maxLogSize\": 123, \"maxDailySize\": 123, \"administrativeState\": 123, \"logOnChange\": \"boolean\", \"logOnDeletion\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "maxLogSize": { "type": "integer" }, "maxDailySize": { "type": "integer" }, "administrativeState": { "type": "integer" }, "logOnChange": { "type": "boolean", "default": false }, "logOnDeletion": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface ConfigInfo AlarmHistoryDatabaseConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restFmAlarmHistoryDatabaseConfigure" }, "task": true }, { "name": "restFmAlarmHistoryDatabaseGetLog", "summary": "getLog", "description": "Intention : RETRIEVER getLog: instance-level retriever API getLog on default instance AlarmHistoryDatabase of class fm.AlarmHistoryDatabase", "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": "/restFmAlarmHistoryDatabaseGetLog" }, "task": true }, { "name": "restFmAlarmHistoryDatabaseGetLogRecords", "summary": "getLogRecords", "description": "Intention : RETRIEVER getLogRecords: class-level retriever API getLogRecords on default instance AlarmHistoryDatabase of class fm.AlarmHistoryDatabase", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restFmAlarmHistoryDatabaseGetLogRecords" }, "task": true }, { "name": "restFmAlarmHistoryDatabasePurge", "summary": "rest_fm_AlarmHistoryDatabase_purge", "description": "rest_fm_AlarmHistoryDatabase_purge", "input": [ { "name": "body", "type": "object", "info": ": {\"logEntityType\": \"string\", \"className\": \"string\", \"purgeType\": \"string\", \"recordFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "className", "logEntityType", "purgeType", "recordFilter" ], "properties": { "logEntityType": { "type": "string", "description": " Type of record to be purged." }, "className": { "type": "string", "description": " Class name of the records to be purged." }, "purgeType": { "type": "string", "description": " Not used." }, "recordFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for LogPolicy.purge to decode json data to internal NFM-P object model" } } ], "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": "/restFmAlarmHistoryDatabasePurge" }, "task": true }, { "name": "restFmFaultManagerAcknowledgeFault", "summary": "rest_fm_FaultManager_acknowledgeFault", "description": "rest_fm_FaultManager_acknowledgeFault", "input": [ { "name": "body", "type": "object", "info": ": {\"faultObjectFullName\": \"string\", \"alteredSeverity\": \"string\", \"urgency\": \"string\", \"text\": \"string\", \"doMarkAsAcknowledged\": \"boolean\", \"doDelete\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "alteredSeverity", "doDelete", "doMarkAsAcknowledged", "faultObjectFullName", "text", "urgency" ], "properties": { "faultObjectFullName": { "type": "string", "description": " Full name of the alarm to be acknowledged." }, "alteredSeverity": { "type": "string", "description": " New severity for the alarm. Unspecified severity leaves the severity unchanged." }, "urgency": { "type": "string", "description": " New urgency for the alarm. Unspecified urgency leaves the urgency unchanged." }, "text": { "type": "string", "description": " Text of the alarm note added as part of the acknowledgment." }, "doMarkAsAcknowledged": { "type": "boolean", "description": " Indicates whether the alarm should be acknowledged or not.", "default": false }, "doDelete": { "type": "boolean", "description": " Indicates whether the alarm should be deleted or not.", "default": false } }, "description": "Model containing the method level model for FaultManager.acknowledgeFault to decode json data to internal NFM-P object model" } } ], "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": "/restFmFaultManagerAcknowledgeFault" }, "task": true }, { "name": "restFmFaultManagerAcknowledgeFaultList", "summary": "rest_fm_FaultManager_acknowledgeFaultList", "description": "rest_fm_FaultManager_acknowledgeFaultList", "input": [ { "name": "body", "type": "object", "info": ": {\"faultObjectNameSet\": \"array\", \"alteredSeverity\": \"string\", \"urgency\": \"string\", \"text\": \"string\", \"doMarkAsAcknowledged\": \"boolean\", \"doDelete\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "alteredSeverity", "doDelete", "doMarkAsAcknowledged", "faultObjectNameSet", "text", "urgency" ], "properties": { "faultObjectNameSet": { "type": "array", "description": " Set of alarm full names to be acknowledged.", "uniqueItems": true, "items": { "type": "string" } }, "alteredSeverity": { "type": "string", "description": " New severity, unspecified severity leaves the severity unchanged." }, "urgency": { "type": "string", "description": " New urgency, unspecified urgency leaves the urgency unchanged." }, "text": { "type": "string", "description": " Text of the alarm note added as part of the acknowledgment." }, "doMarkAsAcknowledged": { "type": "boolean", "description": " Indicates whether to acknowledge the alarm or not.", "default": false }, "doDelete": { "type": "boolean", "description": " Indicates whether to delete the alarm or not.", "default": false } }, "description": "Model containing the method level model for FaultManager.acknowledgeFaultList to decode json data to internal NFM-P object model" } } ], "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": "/restFmFaultManagerAcknowledgeFaultList" }, "task": true }, { "name": "restFmFaultManagerAcknowledgeFaultUsingDefaults", "summary": "rest_fm_FaultManager_acknowledgeFaultUsingDefaults", "description": "rest_fm_FaultManager_acknowledgeFaultUsingDefaults", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restFmFaultManagerAcknowledgeFaultUsingDefaults" }, "task": true }, { "name": "restFmFaultManagerAcknowledgeFaults", "summary": "rest_fm_FaultManager_acknowledgeFaults", "description": "rest_fm_FaultManager_acknowledgeFaults", "input": [ { "name": "body", "type": "object", "info": ": {\"instanceFullName\": \"string\", \"alarmableInstanceFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"faultFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"scopeType\": 123, \"scopeDepth\": 123, \"alteredSeverity\": \"string\", \"urgency\": \"string\", \"text\": \"string\", \"doMarkAsAcknowledged\": \"boolean\", \"doDelete\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "alarmableInstanceFilter", "alteredSeverity", "doDelete", "doMarkAsAcknowledged", "faultFilter", "instanceFullName", "scopeDepth", "scopeType", "text", "urgency" ], "properties": { "instanceFullName": { "type": "string", "description": " Full name of the parent object for which alarms against it or the child objects are to be acknowledged." }, "alarmableInstanceFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "faultFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "scopeType": { "type": "integer", "description": " Scope of the parent and child search:0 = SINGLE_OBJECT1 = SINGLE_LEVEL2 = N_LEVELS3 = WHOLE_SUBTREE" }, "scopeDepth": { "type": "integer", "description": " Indicates the depth of the parent and child search, used when scopeType is 1 (SINGLE_LEVEL) or 2 (N_LEVELS)." }, "alteredSeverity": { "type": "string", "description": " New severity, unspecified severity leaves the severity unchanged." }, "urgency": { "type": "string", "description": " New urgency, unspecified urgency leaves the urgency unchanged." }, "text": { "type": "string", "description": " Text of the alarm note added as part of the acknowledgment." }, "doMarkAsAcknowledged": { "type": "boolean", "description": " Indicates whether to acknowledge the alarm or not.", "default": false }, "doDelete": { "type": "boolean", "description": " Indicates whether to delete the alarm or not.", "default": false } }, "description": "Model containing the method level model for FaultManager.acknowledgeFaults to decode json data to internal NFM-P object model" } } ], "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": "/restFmFaultManagerAcknowledgeFaults" }, "task": true }, { "name": "restFmFaultManagerAlterOLCStateOfFaultList", "summary": "rest_fm_FaultManager_alterOLCStateOfFaultList", "description": "rest_fm_FaultManager_alterOLCStateOfFaultList", "input": [ { "name": "body", "type": "object", "info": ": {\"faultObjectNameSet\": \"array\", \"olcState\": 123}", "required": false, "schema": { "type": "object", "required": [ "faultObjectNameSet", "olcState" ], "properties": { "faultObjectNameSet": { "type": "array", "description": " Set of the alarm full names to have their OLC state updated.", "uniqueItems": true, "items": { "type": "string" } }, "olcState": { "type": "integer", "description": " New OLC state." } }, "description": "Model containing the method level model for FaultManager.alterOLCStateOfFaultList to decode json data to internal NFM-P object model" } } ], "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": "/restFmFaultManagerAlterOLCStateOfFaultList" }, "task": true }, { "name": "restFmFaultManagerAlterSeverityOfFault", "summary": "rest_fm_FaultManager_alterSeverityOfFault", "description": "rest_fm_FaultManager_alterSeverityOfFault", "input": [ { "name": "body", "type": "object", "info": ": {\"faultObjectFullName\": \"string\", \"severity\": 123}", "required": false, "schema": { "type": "object", "required": [ "faultObjectFullName", "severity" ], "properties": { "faultObjectFullName": { "type": "string", "description": " Full name of the alarm to have its severity updated." }, "severity": { "type": "integer", "description": " New severity." } }, "description": "Model containing the method level model for FaultManager.alterSeverityOfFault to decode json data to internal NFM-P object model" } } ], "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": "/restFmFaultManagerAlterSeverityOfFault" }, "task": true }, { "name": "restFmFaultManagerAlterSeverityOfFaultList", "summary": "rest_fm_FaultManager_alterSeverityOfFaultList", "description": "rest_fm_FaultManager_alterSeverityOfFaultList", "input": [ { "name": "body", "type": "object", "info": ": {\"faultObjectNameSet\": \"array\", \"severity\": 123}", "required": false, "schema": { "type": "object", "required": [ "faultObjectNameSet", "severity" ], "properties": { "faultObjectNameSet": { "type": "array", "description": " Set of the alarm full names to have their severity updated.", "uniqueItems": true, "items": { "type": "string" } }, "severity": { "type": "integer", "description": " New severity." } }, "description": "Model containing the method level model for FaultManager.alterSeverityOfFaultList to decode json data to internal NFM-P object model" } } ], "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": "/restFmFaultManagerAlterSeverityOfFaultList" }, "task": true }, { "name": "restFmFaultManagerAlterSeverityOfFaultsOnObject", "summary": "rest_fm_FaultManager_alterSeverityOfFaultsOnObject", "description": "rest_fm_FaultManager_alterSeverityOfFaultsOnObject", "input": [ { "name": "body", "type": "object", "info": ": {\"baseInstanceFullName\": \"string\", \"faultFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"severity\": 123}", "required": false, "schema": { "type": "object", "required": [ "baseInstanceFullName", "faultFilter", "severity" ], "properties": { "baseInstanceFullName": { "type": "string", "description": " Full name of the affected object for which alarms against it should have their severity updated." }, "faultFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "severity": { "type": "integer", "description": " New severity." } }, "description": "Model containing the method level model for FaultManager.alterSeverityOfFaultsOnObject to decode json data to internal NFM-P object model" } } ], "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": "/restFmFaultManagerAlterSeverityOfFaultsOnObject" }, "task": true }, { "name": "restFmFaultManagerAlterUrgencyOfFault", "summary": "rest_fm_FaultManager_alterUrgencyOfFault", "description": "rest_fm_FaultManager_alterUrgencyOfFault", "input": [ { "name": "body", "type": "object", "info": ": {\"faultObjectFullName\": \"string\", \"urgency\": 123}", "required": false, "schema": { "type": "object", "required": [ "faultObjectFullName", "urgency" ], "properties": { "faultObjectFullName": { "type": "string", "description": " Alarm full name for which the urgency is to be updated." }, "urgency": { "type": "integer", "description": " New urgency." } }, "description": "Model containing the method level model for FaultManager.alterUrgencyOfFault to decode json data to internal NFM-P object model" } } ], "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": "/restFmFaultManagerAlterUrgencyOfFault" }, "task": true }, { "name": "restFmFaultManagerAlterUrgencyOfFaultList", "summary": "rest_fm_FaultManager_alterUrgencyOfFaultList", "description": "rest_fm_FaultManager_alterUrgencyOfFaultList", "input": [ { "name": "body", "type": "object", "info": ": {\"faultObjectNameSet\": \"array\", \"urgency\": 123}", "required": false, "schema": { "type": "object", "required": [ "faultObjectNameSet", "urgency" ], "properties": { "faultObjectNameSet": { "type": "array", "description": " Set of alarm full names for which the urgency is to be updated.", "uniqueItems": true, "items": { "type": "string" } }, "urgency": { "type": "integer", "description": " New urgency." } }, "description": "Model containing the method level model for FaultManager.alterUrgencyOfFaultList to decode json data to internal NFM-P object model" } } ], "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": "/restFmFaultManagerAlterUrgencyOfFaultList" }, "task": true }, { "name": "restFmFaultManagerAlterUrgencyOfFaultsOnObject", "summary": "rest_fm_FaultManager_alterUrgencyOfFaultsOnObject", "description": "rest_fm_FaultManager_alterUrgencyOfFaultsOnObject", "input": [ { "name": "body", "type": "object", "info": ": {\"baseInstanceFullName\": \"string\", \"faultFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"urgency\": 123}", "required": false, "schema": { "type": "object", "required": [ "baseInstanceFullName", "faultFilter", "urgency" ], "properties": { "baseInstanceFullName": { "type": "string", "description": " Full name of the affected object for which alarms against it are to have their urgency updated." }, "faultFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "urgency": { "type": "integer", "description": " New urgency." } }, "description": "Model containing the method level model for FaultManager.alterUrgencyOfFaultsOnObject to decode json data to internal NFM-P object model" } } ], "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": "/restFmFaultManagerAlterUrgencyOfFaultsOnObject" }, "task": true }, { "name": "restFmFaultManagerClearFault", "summary": "rest_fm_FaultManager_clearFault", "description": "rest_fm_FaultManager_clearFault", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restFmFaultManagerClearFault" }, "task": true }, { "name": "restFmFaultManagerClearFaultList", "summary": "rest_fm_FaultManager_clearFaultList", "description": "rest_fm_FaultManager_clearFaultList", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restFmFaultManagerClearFaultList" }, "task": true }, { "name": "restFmFaultManagerClearFaultsOnObject", "summary": "rest_fm_FaultManager_clearFaultsOnObject", "description": "rest_fm_FaultManager_clearFaultsOnObject", "input": [ { "name": "body", "type": "object", "info": ": {\"baseInstanceFullName\": \"string\", \"faultFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "baseInstanceFullName", "faultFilter" ], "properties": { "baseInstanceFullName": { "type": "string", "description": " Full name of the affected object on which the alarms should be cleared." }, "faultFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for FaultManager.clearFaultsOnObject to decode json data to internal NFM-P object model" } } ], "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": "/restFmFaultManagerClearFaultsOnObject" }, "task": true }, { "name": "restFmFaultManagerEditNote", "summary": "rest_fm_FaultManager_editNote", "description": "rest_fm_FaultManager_editNote", "input": [ { "name": "body", "type": "object", "info": ": {\"alarmNoteObjectPointer\": \"string\", \"text\": \"string\", \"reasonForChange\": 123, \"textualExplanation\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "alarmNoteObjectPointer", "reasonForChange", "text", "textualExplanation" ], "properties": { "alarmNoteObjectPointer": { "type": "string", "description": " Full name of the alarm note." }, "text": { "type": "string", "description": " Edited text." }, "reasonForChange": { "type": "integer", "description": " Reason for change, please refer to {{fm.AlarmNoteRevisionObject.reasonForChange}} for details." }, "textualExplanation": { "type": "string", "description": " Textual explanation for the change." } }, "description": "Model containing the method level model for FaultManager.editNote to decode json data to internal NFM-P object model" } } ], "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": "/restFmFaultManagerEditNote" }, "task": true }, { "name": "restFmFaultManagerFindAlarmsForOfn", "summary": "findAlarmsForOfn", "description": "This method returns a structure that contains every alarm in the self, affecting, aggregated and related categories for the specified object. Intention : RETRIEVER findAlarmsForOfn: class-level [object finder] (retriever) API findAlarmsForOfn on default instance faultManager of class fm.FaultManager Alarm list structure.", "input": [ { "name": "alarmedObjectOfn", "type": "string", "info": ": string", "required": false, "schema": { "title": "alarmedObjectOfn", "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": "/restFmFaultManagerFindAlarmsForOfn" }, "task": true }, { "name": "restFmFaultManagerFindAlarmsForOfns", "summary": "findAlarmsForOfns", "description": "This method returns a map of the structures that contain every alarm self, affecting, aggregated and related categories for the specified object. Intention : RETRIEVER findAlarmsForOfns: class-level [object finder] (retriever) API findAlarmsForOfns on default instance faultManager of class fm.FaultManager Map of alarm structures. The map key is the affected object full name.", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restFmFaultManagerFindAlarmsForOfns" }, "task": true }, { "name": "restFmFaultManagerFindAlarmsStatusesForOfn", "summary": "findAlarmsStatusesForOfn", "description": "This method returns a structure that contains the alarm status and aggregated alarm status for the specified object. Intention : RETRIEVER findAlarmsStatusesForOfn: class-level [object finder] (retriever) API findAlarmsStatusesForOfn on default instance faultManager of class fm.FaultManager Alarm statuses for the specified object.", "input": [ { "name": "alarmedObjectOfn", "type": "string", "info": ": string", "required": false, "schema": { "title": "alarmedObjectOfn", "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": "/restFmFaultManagerFindAlarmsStatusesForOfn" }, "task": true }, { "name": "restFmFaultManagerFindAlarmsStatusesForOfns", "summary": "findAlarmsStatusesForOfns", "description": "This method returns a list of structures that contains the alarm status and aggregated alarm status for the specified objects. Intention : RETRIEVER findAlarmsStatusesForOfns: class-level [object finder] (retriever) API findAlarmsStatusesForOfns on default instance faultManager of class fm.FaultManager Map of the alarm statuses. The map key is the affected object full name.", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restFmFaultManagerFindAlarmsStatusesForOfns" }, "task": true }, { "name": "restFmFaultManagerFindFault", "summary": "findFault", "description": "This method returns the specified alarm. Intention : RETRIEVER findFault: class-level [object finder] (retriever) API findFault on default instance faultManager of class fm.FaultManager Alarm for the specified full name.", "input": [ { "name": "alarmInstanceFullName", "type": "string", "info": ": string", "required": false, "schema": { "title": "alarmInstanceFullName", "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": "/restFmFaultManagerFindFault" }, "task": true }, { "name": "restFmFaultManagerFindFaultList", "summary": "findFaultList", "description": "This method returns the specified alarms. Intention : RETRIEVER findFaultList: class-level [object finder] (retriever) API findFaultList on default instance faultManager of class fm.FaultManager Map of alarms. The alarm full name is the map key.", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restFmFaultManagerFindFaultList" }, "task": true }, { "name": "restFmFaultManagerFindFaults", "summary": "findFaults", "description": "This method retrieves all alarms in the network matching the faultFilter criteria and returns a map. Intention : RETRIEVER findFaults: class-level [object finder] (retriever) API findFaults on default instance faultManager of class fm.FaultManager Map of alarms. The alarm full name is the map key.", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restFmFaultManagerFindFaults" }, "task": true }, { "name": "restFmFaultManagerFindFaultsOnObject", "summary": "findFaultsOnObject", "description": "This method retrieves alarms on the specified affected object. Intention : RETRIEVER findFaultsOnObject: class-level [object finder] (retriever) API findFaultsOnObject on default instance faultManager of class fm.FaultManager Map of alarms on the specified affected object. The alarm full name is the map key.", "input": [ { "name": "body", "type": "object", "info": ": {\"baseInstanceFullName\": \"string\", \"faultFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "baseInstanceFullName", "faultFilter" ], "properties": { "baseInstanceFullName": { "type": "string", "description": " Full name of the affected object on which the alarms should be listed." }, "faultFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for FaultManager.findFaultsOnObject to decode json data to internal NFM-P object model" } } ], "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": "/restFmFaultManagerFindFaultsOnObject" }, "task": true }, { "name": "restFmFaultManagerFindNoteForAlarmInstance", "summary": "findNoteForAlarmInstance", "description": "This method retrieves alarm notes for the specified alarm. Intention : RETRIEVER findNoteForAlarmInstance: class-level [object finder] (retriever) API findNoteForAlarmInstance on default instance faultManager of class fm.FaultManager List of alarm notes.", "input": [ { "name": "body", "type": "object", "info": ": {\"alarmInstancePointer\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "alarmInstancePointer", "filter" ], "properties": { "alarmInstancePointer": { "type": "string", "description": " Full name of the alarm." }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for FaultManager.findNoteForAlarmInstance to decode json data to internal NFM-P object model" } } ], "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": "/restFmFaultManagerFindNoteForAlarmInstance" }, "task": true }, { "name": "restFmFaultManagerFindObjectsAffectingOfn", "summary": "findObjectsAffectingOfn", "description": "This method returns a list of the affecting objects full names for the specified object. Intention : RETRIEVER findObjectsAffectingOfn: class-level [object finder] (retriever) API findObjectsAffectingOfn on default instance faultManager of class fm.FaultManager List of full names of the affecting objects.", "input": [ { "name": "alarmedObjectOfn", "type": "string", "info": ": string", "required": false, "schema": { "title": "alarmedObjectOfn", "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": "/restFmFaultManagerFindObjectsAffectingOfn" }, "task": true }, { "name": "restFmFaultManagerFindObjectsRelatedToOfn", "summary": "findObjectsRelatedToOfn", "description": "This method returns a list of the related objects full names for the specified object. Intention : RETRIEVER findObjectsRelatedToOfn: class-level [object finder] (retriever) API findObjectsRelatedToOfn on default instance faultManager of class fm.FaultManager List of full names of the related objects.", "input": [ { "name": "alarmedObjectOfn", "type": "string", "info": ": string", "required": false, "schema": { "title": "alarmedObjectOfn", "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": "/restFmFaultManagerFindObjectsRelatedToOfn" }, "task": true }, { "name": "restFmFaultManagerGetAlarms", "summary": "getAlarms", "description": "This method returns all the alarms in the system without relationships (affecting related objects). Intention : RETRIEVER getAlarms: class-level retriever API getAlarms on default instance faultManager of class fm.FaultManager Map of alarms. The alarm full name is the map key.", "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": "/restFmFaultManagerGetAlarms" }, "task": true }, { "name": "restFmFaultManagerGetCorrelatedAlarmsForOfn", "summary": "getCorrelatedAlarmsForOfn", "description": "This method returns the correlated alarms for the specified alarm name. Intention : RETRIEVER getCorrelatedAlarmsForOfn: class-level retriever API getCorrelatedAlarmsForOfn on default instance faultManager of class fm.FaultManager Map of correlated alarms. The correlated alarm full name is the map key.", "input": [ { "name": "alarmInstancePointer", "type": "string", "info": ": string", "required": false, "schema": { "title": "alarmInstancePointer", "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": "/restFmFaultManagerGetCorrelatedAlarmsForOfn" }, "task": true }, { "name": "restFmFaultManagerReload", "summary": "rest_fm_FaultManager_reload", "description": "rest_fm_FaultManager_reload", "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": "/restFmFaultManagerReload" }, "task": true }, { "name": "restFmFaultManagerRemoveFault", "summary": "rest_fm_FaultManager_removeFault", "description": "rest_fm_FaultManager_removeFault", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restFmFaultManagerRemoveFault" }, "task": true }, { "name": "restFmFaultManagerRemoveFaultList", "summary": "rest_fm_FaultManager_removeFaultList", "description": "rest_fm_FaultManager_removeFaultList", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restFmFaultManagerRemoveFaultList" }, "task": true }, { "name": "restFmFaultManagerRemoveFaultsOnObject", "summary": "rest_fm_FaultManager_removeFaultsOnObject", "description": "rest_fm_FaultManager_removeFaultsOnObject", "input": [ { "name": "body", "type": "object", "info": ": {\"baseInstanceFullName\": \"string\", \"faultFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "baseInstanceFullName", "faultFilter" ], "properties": { "baseInstanceFullName": { "type": "string", "description": " Full name of the affected object on which the alarms should be deleted." }, "faultFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for FaultManager.removeFaultsOnObject to decode json data to internal NFM-P object model" } } ], "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": "/restFmFaultManagerRemoveFaultsOnObject" }, "task": true }, { "name": "restFmFaultManagerTestAlarm", "summary": "rest_fm_FaultManager_testAlarm", "description": "rest_fm_FaultManager_testAlarm", "input": [ { "name": "body", "type": "object", "info": ": {\"objectInstanceName\": \"string\", \"alarmNameId\": 123, \"alarmTypeId\": 123, \"probableCauseId\": 123, \"severity\": \"string\", \"alarmClassTag\": \"string\", \"namingComponent\": \"string\", \"additionalText\": \"string\", \"nodeTimeOffset\": 123}", "required": false, "schema": { "type": "object", "required": [ "additionalText", "alarmClassTag", "alarmNameId", "alarmTypeId", "namingComponent", "nodeTimeOffset", "objectInstanceName", "probableCauseId", "severity" ], "properties": { "objectInstanceName": { "type": "string", "description": " Full name of the managed object on which to create the test alarm." }, "alarmNameId": { "type": "integer", "description": " Alarm name of the test alarm. please refer to {{fm.AlarmObject.alarmName}} for details." }, "alarmTypeId": { "type": "integer", "description": " Alarm type of the test alarm. please refer to {{fm.AlarmObject.type}} for details." }, "probableCauseId": { "type": "integer", "description": " Probable cause of the test alarm. please refer to {{fm.AlarmObject.probableCause}} for details." }, "severity": { "type": "string", "description": " Severity of the test alarm. please refer to {{fm.AlarmObject.severity}} for details." }, "alarmClassTag": { "type": "string", "description": " Alarm class tag of the test alarm. please refer to {{fm.AlarmObject.alarmClassTag}} for details." }, "namingComponent": { "type": "string", "description": " Naming component of the test alarm. Used to distinguish two alarms with the same name, type and probable cause on the same affected object." }, "additionalText": { "type": "string", "description": " Additional text of the test alarm." }, "nodeTimeOffset": { "type": "integer", "description": " Node time offset indicating the time zone." } }, "description": "Model containing the method level model for FaultManager.testAlarm to decode json data to internal NFM-P object model" } } ], "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": "/restFmFaultManagerTestAlarm" }, "task": true }, { "name": "restFmFaultManagerVerifyAlarmStatus", "summary": "rest_fm_FaultManager_verifyAlarmStatus", "description": "rest_fm_FaultManager_verifyAlarmStatus", "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": "/restFmFaultManagerVerifyAlarmStatus" }, "task": true }, { "name": "restFmGlobalPolicyConfigure", "summary": "rest_fm_GlobalPolicy_configure", "description": "rest_fm_GlobalPolicy_configure", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"isSeverityAlterable\": \"boolean\", \"isSeverityManuallyAlterable\": \"boolean\", \"isSeverityManualPromotionEnabled\": \"boolean\", \"isSeverityManualDemotionEnabled\": \"boolean\", \"isSeverityManualClearingEnabled\": \"boolean\", \"isSeverityAutoAlterable\": \"boolean\", \"isSeverityImplicitPromotionEnabled\": \"boolean\", \"isSeverityImplicitDemotionEnabled\": \"boolean\", \"isSeverityEscalationEnabled\": \"boolean\", \"isSeverityDeEscalationEnabled\": \"boolean\", \"freqencyUpdateRule\": 123, \"severityEscalatorWorkerFrequency\": 123, \"isAlarmDeletionEnabled\": \"boolean\", \"manualDeletionRule\": 123, \"implicitDeletionRule\": 123, \"correlatedAlarmDeletionRule\": 123, \"nonClearableImplicitDeletionRule\": 123, \"timerBasedDeletonRule\": 123, \"deletionTimer\": 123, \"deletionWorkerFrequency\": 123, \"optimizeAlarmEventBuffer\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "isSeverityAlterable": { "type": "boolean", "default": false }, "isSeverityManuallyAlterable": { "type": "boolean", "default": false }, "isSeverityManualPromotionEnabled": { "type": "boolean", "default": false }, "isSeverityManualDemotionEnabled": { "type": "boolean", "default": false }, "isSeverityManualClearingEnabled": { "type": "boolean", "default": false }, "isSeverityAutoAlterable": { "type": "boolean", "default": false }, "isSeverityImplicitPromotionEnabled": { "type": "boolean", "default": false }, "isSeverityImplicitDemotionEnabled": { "type": "boolean", "default": false }, "isSeverityEscalationEnabled": { "type": "boolean", "default": false }, "isSeverityDeEscalationEnabled": { "type": "boolean", "default": false }, "freqencyUpdateRule": { "type": "integer" }, "severityEscalatorWorkerFrequency": { "type": "integer" }, "isAlarmDeletionEnabled": { "type": "boolean", "default": false }, "manualDeletionRule": { "type": "integer" }, "implicitDeletionRule": { "type": "integer" }, "correlatedAlarmDeletionRule": { "type": "integer" }, "nonClearableImplicitDeletionRule": { "type": "integer" }, "timerBasedDeletonRule": { "type": "integer" }, "deletionTimer": { "type": "integer" }, "deletionWorkerFrequency": { "type": "integer" }, "optimizeAlarmEventBuffer": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface ConfigInfo GlobalPolicyConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restFmGlobalPolicyConfigure" }, "task": true }, { "name": "restFmSeverityChangeThresholdConfigure", "summary": "rest_fm_SeverityChangeThreshold_configure", "description": "rest_fm_SeverityChangeThreshold_configure", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"direction\": 123, \"frequencyThreshold\": 123, \"associatedSeverity\": 123, \"occurrenceThreshold\": 123}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "direction": { "type": "integer" }, "frequencyThreshold": { "type": "integer" }, "associatedSeverity": { "type": "integer" }, "occurrenceThreshold": { "type": "integer" } }, "description": "Model containing the method level model for Interface ConfigInfo SeverityChangeThresholdConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restFmSeverityChangeThresholdConfigure" }, "task": true }, { "name": "restFmSpecificPolicyConfigure", "summary": "rest_fm_SpecificPolicy_configure", "description": "rest_fm_SpecificPolicy_configure", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"specificAlarmInterval\": 123, \"alarmClassName\": \"string\", \"groupTag\": \"string\", \"isSquelched\": \"boolean\", \"autoAssignedSeverity\": 123, \"autoAssignedUrgency\": 123, \"autoDeletionRule\": 123, \"userText\": \"string\", \"alarmDebouncingHoldPeriod\": 123, \"alarmDebouncingEnabled\": \"boolean\", \"escalationEnabled\": \"boolean\", \"deEscalationEnabled\": \"boolean\", \"historyEnabled\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "specificAlarmInterval": { "type": "integer" }, "alarmClassName": { "type": "string" }, "groupTag": { "type": "string" }, "isSquelched": { "type": "boolean", "default": false }, "autoAssignedSeverity": { "type": "integer" }, "autoAssignedUrgency": { "type": "integer" }, "autoDeletionRule": { "type": "integer" }, "userText": { "type": "string" }, "alarmDebouncingHoldPeriod": { "type": "integer" }, "alarmDebouncingEnabled": { "type": "boolean", "default": false }, "escalationEnabled": { "type": "boolean", "default": false }, "deEscalationEnabled": { "type": "boolean", "default": false }, "historyEnabled": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface ConfigInfo SpecificPolicyConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restFmSpecificPolicyConfigure" }, "task": true }, { "name": "restFmSpecificPolicyFindSpecificPolicies", "summary": "findSpecificPolicies", "description": "Intention : RETRIEVER findSpecificPolicies: class-level [object finder] (retriever) API findSpecificPolicies of class fm.SpecificPolicy", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restFmSpecificPolicyFindSpecificPolicies" }, "task": true }, { "name": "restCoregeristryApplicationRegisterFind", "summary": "Find", "description": "The find method returns a set of objects of the type specified in the fullClassName element that match the filter criteria. The method response is a XML result.For example, the client makes the following HTTP request:\n\n\n POST /v2/general/find HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n {\"fullClassName\":\"netw.NetworkElement\", \"resultFilter\": { \"attributes\": [\"objectFullName\",\"site...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"resultFilter\": {\"recursive\": \"boolean\", \"attributes\": \"array\", \"fullClassName\": \"string\", \"childrenFilters\": [{\"recursive\": \"boolean\", \"attributes\": \"array\", \"fullClassName\": \"string\", \"childrenFilters\": \"array\"}]}}", "required": false, "schema": { "type": "object", "required": [ "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "resultFilter": { "type": "object", "required": [ "attributes" ], "properties": { "recursive": { "type": "boolean", "default": false }, "attributes": { "type": "array", "description": "List [String]", "items": { "type": "string" } }, "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "childrenFilters": { "type": "array", "description": " List [ResultFilter]", "items": { "type": "object", "required": [ "attributes" ], "properties": { "recursive": { "type": "boolean", "default": false }, "attributes": { "type": "array", "description": "List [String]", "items": { "type": "string" } }, "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "childrenFilters": { "type": "array", "description": " List [ResultFilter]", "items": { "type": "object" } } }, "description": "Result filter class" } } }, "description": "Result filter class" } }, "description": "Find" } } ], "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": "/restCoregeristryApplicationRegisterFind" }, "task": true }, { "name": "restCoregeristryApplicationRegisterFindToFile", "summary": "Find to file", "description": "The findToFile method returns a set of objects of the type specified in the fullClassName element that match the filter criteria. You can specify the following result file storage options:\n - save the file locally on the NFM-P server\n - use FTP to transfer the results to a remote host\n\nFile content will be in XML format.\n\nBy default, the findToFile method runs synchronously, which means that one request has to complete and return before the processing of the next request begins.\n The NFM-P retur...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"array\", \"fileName\": \"string\", \"compress\": \"boolean\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"synchronous\": \"boolean\", \"resultFilter\": {\"recursive\": \"boolean\", \"attributes\": \"array\", \"fullClassName\": \"string\", \"childrenFilters\": [{\"recursive\": \"boolean\", \"attributes\": \"array\", \"fullClassName\": \"string\", \"childrenFilters\": \"array\"}]}, \"timeStamp\": \"boolean\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "fileName", "fullClassName" ], "properties": { "fullClassName": { "type": "array", "description": "list", "items": { "type": "string" } }, "fileName": { "type": "string", "example": "myFile.xml", "description": "string" }, "compress": { "type": "boolean", "example": "true", "description": "boolean", "default": false }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "synchronous": { "type": "boolean", "example": "false", "description": "boolean", "default": false }, "resultFilter": { "type": "object", "required": [ "attributes" ], "properties": { "recursive": { "type": "boolean", "default": false }, "attributes": { "type": "array", "description": "List [String]", "items": { "type": "string" } }, "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "childrenFilters": { "type": "array", "description": " List [ResultFilter]", "items": { "type": "object", "required": [ "attributes" ], "properties": { "recursive": { "type": "boolean", "default": false }, "attributes": { "type": "array", "description": "List [String]", "items": { "type": "string" } }, "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "childrenFilters": { "type": "array", "description": " List [ResultFilter]", "items": { "type": "object" } } }, "description": "Result filter class" } } }, "description": "Result filter class" }, "timeStamp": { "type": "boolean", "example": "true", "description": "boolean", "default": false }, "timeout": { "type": "integer", "example": "1000", "description": "long" } }, "description": "RestRegister Find to file model" } } ], "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": "/restCoregeristryApplicationRegisterFindToFile" }, "task": true }, { "name": "restCoregeristryApplicationRegisterPing", "summary": "Ping", "description": "The ping method can be used to test whether the OSS application can access the NFM-P server. A successful ping returns an empty response. A failed ping may result in many types of return messages, for example:\n - socket timeouts\n - HTTP 404 errors\n - connection exceptions", "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": "/restCoregeristryApplicationRegisterPing" }, "task": true }, { "name": "restCoregeristryApplicationRegister", "summary": "Register log to file", "description": "Create accounting or performance statistics data files for specific classes. When the registerLogToFile method is used, the specific statistics files are generated on an NFM-P server with the requested data for each registered client. Content is generated to file independent of database storage.\n\nA LogFileAvailableEvent is sent each time a file is ready for retrieval, if the client subscribes to specific Kafka Categories. See Kafka Notification Service Tutorial on the NSP Developer Portal at ne...(description truncated)", "input": [ { "name": "clientId", "type": "string", "info": ": string", "required": true, "schema": { "title": "clientId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"array\", \"dirName\": \"string\", \"compress\": \"boolean\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"resultFilter\": {\"recursive\": \"boolean\", \"attributes\": \"array\", \"fullClassName\": \"string\", \"childrenFilters\": [{\"recursive\": \"boolean\", \"attributes\": \"array\", \"fullClassName\": \"string\", \"childrenFilters\": \"array\"}]}}", "required": false, "schema": { "type": "object", "required": [ "dirName", "fullClassName" ], "properties": { "fullClassName": { "type": "array", "description": "list", "uniqueItems": true, "items": { "type": "string" } }, "dirName": { "type": "string", "example": "/myDir", "description": "string" }, "compress": { "type": "boolean", "example": "true", "description": "boolean", "default": false }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "resultFilter": { "type": "object", "required": [ "attributes" ], "properties": { "recursive": { "type": "boolean", "default": false }, "attributes": { "type": "array", "description": "List [String]", "items": { "type": "string" } }, "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "childrenFilters": { "type": "array", "description": " List [ResultFilter]", "items": { "type": "object", "required": [ "attributes" ], "properties": { "recursive": { "type": "boolean", "default": false }, "attributes": { "type": "array", "description": "List [String]", "items": { "type": "string" } }, "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "childrenFilters": { "type": "array", "description": " List [ResultFilter]", "items": { "type": "object" } } }, "description": "Result filter class" } } }, "description": "Result filter class" } }, "description": "RestRegister Log To File model" } } ], "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": "/restCoregeristryApplicationRegister" }, "task": true }, { "name": "restCoregeristryApplicationDeregister", "summary": "Deregister log to file", "description": "Deregister from receiving notifications for accounting and performance statistics and stop the export file creation. Deregistration also occurs when the client Kafka subscription expires. The NFM-P checks client connectivity every 5 minutes; you can use a GUI client to configure the maximum number of intervals before a disconnected client is deregistered. See \"System preferences configuration procedures\" in the NSP NFM-P System Administrator Guide. A deregistered client must re-register to recei...(description truncated)", "input": [ { "name": "clientId", "type": "string", "info": ": string", "required": true, "schema": { "title": "clientId", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restCoregeristryApplicationDeregister" }, "task": true }, { "name": "restCoregeristryApplicationRegisterSasLogToFile", "summary": "Register SAS Log to file", "description": "Retrieve OAM test result export files for specific test class results. A LogFileAvailableEvent is sent each time a file is available for retrieval; a client must subscribe to Kafka to receive the events. By default, if the client is not subscribed, no result files are created, and the NFM-P deregisters the client after a period of client inactivity. A Kafka subscription for registerSasLogToFile is optional, however; you can disable the client inactivity check to ensure that no deregistration occ...(description truncated)", "input": [ { "name": "clientId", "type": "string", "info": ": string", "required": true, "schema": { "title": "clientId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"array\", \"dirName\": \"string\", \"compress\": \"boolean\", \"resultFilter\": {\"recursive\": \"boolean\", \"attributes\": \"array\", \"fullClassName\": \"string\", \"childrenFilters\": [{\"recursive\": \"boolean\", \"attributes\": \"array\", \"fullClassName\": \"string\", \"childrenFilters\": \"array\"}]}}", "required": false, "schema": { "type": "object", "required": [ "dirName", "fullClassName" ], "properties": { "fullClassName": { "type": "array", "description": "list", "items": { "type": "string" } }, "dirName": { "type": "string", "example": "/myDir", "description": "string" }, "compress": { "type": "boolean", "example": "true", "description": "boolean", "default": false }, "resultFilter": { "type": "object", "required": [ "attributes" ], "properties": { "recursive": { "type": "boolean", "default": false }, "attributes": { "type": "array", "description": "List [String]", "items": { "type": "string" } }, "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "childrenFilters": { "type": "array", "description": " List [ResultFilter]", "items": { "type": "object", "required": [ "attributes" ], "properties": { "recursive": { "type": "boolean", "default": false }, "attributes": { "type": "array", "description": "List [String]", "items": { "type": "string" } }, "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "childrenFilters": { "type": "array", "description": " List [ResultFilter]", "items": { "type": "object" } } }, "description": "Result filter class" } } }, "description": "Result filter class" } }, "description": "RestRegister SAS Log to file model" } } ], "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": "/restCoregeristryApplicationRegisterSasLogToFile" }, "task": true }, { "name": "restCoregeristryApplicationDeregisterSasLogToFile", "summary": "Deregister SAS Log to file", "description": "Deregister from receiving notifications for OAM test results and stop the export file creation.\n\nThe optional fullClassName parameter takes a list of package qualified class names in dot-separated format to deregister. If this parameter is not specified, the method deregisters all test results registrations. If a class is not an instance of sas.TestResult or sas.TraceHop, an exception occurs and no classes are deregistered.\n\nFor example, the client makes the following HTTP request:\n\n DELETE ...(description truncated)", "input": [ { "name": "clientId", "type": "string", "info": ": string", "required": true, "schema": { "title": "clientId", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restCoregeristryApplicationDeregisterSasLogToFile" }, "task": true }, { "name": "restCoregeristryApplicationRegisterTimestamp", "summary": "Timestamp", "description": "Returns the current Java time on the NFM-P server.", "input": [ { "name": "body", "type": "object", "info": ": {\"includeFormatted\": \"boolean\"}", "required": false, "schema": { "type": "object", "properties": { "includeFormatted": { "type": "boolean", "example": "true", "description": "boolean", "default": false } }, "description": "TimeStamp Request DTO" } } ], "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": "/restCoregeristryApplicationRegisterTimestamp" }, "task": true }, { "name": "restCoregeristryApplicationRegisterVersion", "summary": "Version", "description": "Returns NFM-P software release information.", "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": "/restCoregeristryApplicationRegisterVersion" }, "task": true }, { "name": "restGenericGenericObjectClearDeployer", "summary": "rest_generic_GenericObject_clearDeployer", "description": "rest_generic_GenericObject_clearDeployer", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restGenericGenericObjectClearDeployer" }, "task": true }, { "name": "restGenericGenericObjectCompareObjects", "summary": "compareObjects", "description": "Performs a comparison starting at the 2 given objects. The two objects must support object comparison and be compatible, otherwise an exception is thrown. Intention : RETRIEVER compareObjects: class-level retriever API compareObjects of class generic.GenericObject The results of the comparison.", "input": [ { "name": "body", "type": "object", "info": ": {\"comparisonFilter\": {\"objectClassName\": \"string\", \"classesToProcess\": \"array\", \"includedDiffTypes\": \"object\", \"includedProperties\": \"object\", \"flapProperties\": \"object\", \"includeOnlyDiffs\": \"boolean\", \"isClassSpecificFilterConfigured\": \"boolean\"}, \"compareStarter\": \"string\", \"base\": \"string\", \"compareTo\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "base", "compareStarter", "compareTo", "comparisonFilter" ], "properties": { "comparisonFilter": { "type": "object", "required": [ "classesToProcess", "flapProperties", "includeOnlyDiffs", "includedDiffTypes", "includedProperties", "isClassSpecificFilterConfigured", "objectClassName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "classesToProcess": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "includedDiffTypes": { "type": "object", "additionalProperties": { "type": "array", "uniqueItems": true, "items": { "type": "integer" } } }, "includedProperties": { "type": "object", "additionalProperties": { "type": "array", "uniqueItems": true, "items": { "type": "string" } } }, "flapProperties": { "type": "object", "additionalProperties": { "type": "array", "uniqueItems": true, "items": { "type": "string" } } }, "includeOnlyDiffs": { "type": "boolean", "default": false }, "isClassSpecificFilterConfigured": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for struct ComparisonFilter. to decode json data to internal NFM-P object model" }, "compareStarter": { "type": "string", "description": " The compare starter object that is implementing the StructCompareStartIf which,starts the comparison between the base and compareTo. CompareStrater is only usedwhen comparing structs and is not used when comparing managed objects." }, "base": { "type": "string", "description": " The base of the comparison." }, "compareTo": { "type": "string", "description": " The base is being compared to this object." } }, "description": "Model containing the method level model for GenericObject.compareObjects to decode json data to internal NFM-P object model" } } ], "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": "/restGenericGenericObjectCompareObjects" }, "task": true }, { "name": "restGenericGenericObjectConfigureChildInstance", "summary": "configureChildInstance", "description": "Creates a child of the object with the desired configuration values for the child or children objects, and optional grandchildren. Intention : MODIFIER configureChildInstance: class-level [hierarchical administrative configuration/modification] (modifier) API configureChildInstance of class generic.GenericObject This API follows hierarchical config model rules. Returns fullname of the child created.", "input": [ { "name": "body", "type": "object", "info": ": {\"distinguishedName\": \"string\", \"childConfigInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}}", "required": false, "schema": { "type": "object", "required": [ "childConfigInfo", "distinguishedName" ], "properties": { "distinguishedName": { "type": "string", "description": " Distinguished Name of parent under which object is being configured." }, "childConfigInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for GenericObject.configureChildInstance to decode json data to internal NFM-P object model" } } ], "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": "/restGenericGenericObjectConfigureChildInstance" }, "task": true }, { "name": "restGenericGenericObjectConfigureChildInstanceWithResult", "summary": "configureChildInstanceWithResult", "description": "Creates a child of an existing object. The method returns the newly configured parameters on the child object and grandchildren, including parameters set due to associated conditions. Intention : MODIFIER configureChildInstanceWithResult: class-level [hierarchical administrative configuration/modification] (modifier) API configureChildInstanceWithResult of class generic.GenericObject This API follows hierarchical config model rules. Resulting child object (grandchildren included, if applic...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"distinguishedName\": \"string\", \"childConfigInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}}", "required": false, "schema": { "type": "object", "required": [ "childConfigInfo", "distinguishedName" ], "properties": { "distinguishedName": { "type": "string", "description": " Distinguished Name of parent under which object is being configured." }, "childConfigInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for GenericObject.configureChildInstanceWithResult to decode json data to internal NFM-P object model" } } ], "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": "/restGenericGenericObjectConfigureChildInstanceWithResult" }, "task": true }, { "name": "restGenericGenericObjectConfigureInstance", "summary": "rest_generic_GenericObject_configureInstance", "description": "rest_generic_GenericObject_configureInstance", "input": [ { "name": "body", "type": "object", "info": ": {\"distinguishedName\": \"string\", \"configInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}}", "required": false, "schema": { "type": "object", "required": [ "configInfo", "distinguishedName" ], "properties": { "distinguishedName": { "type": "string", "description": " Distinguished Name of object being configured." }, "configInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for GenericObject.configureInstance to decode json data to internal NFM-P object model" } } ], "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": "/restGenericGenericObjectConfigureInstance" }, "task": true }, { "name": "restGenericGenericObjectConfigureInstanceWithResult", "summary": "configureInstanceWithResult", "description": "Modifies an existing object and associated children. The method returns the newly configured parameters on the object and child, including parameters set due to associated conditions. Intention : MODIFIER configureInstanceWithResult: class-level [hierarchical administrative configuration/modification] (modifier) API configureInstanceWithResult of class generic.GenericObject This API follows hierarchical config model rules. Resulting object (children included, if requested, unless otherwise...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"distinguishedName\": \"string\", \"configInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}, \"includeChildren\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "configInfo", "distinguishedName", "includeChildren" ], "properties": { "distinguishedName": { "type": "string", "description": " Distinguished Name of object being configured." }, "configInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" }, "includeChildren": { "type": "boolean", "description": " If false, only the resulting object will be returned from call.If true, resulting object and all children will be returned.Note that some classes do not return children. In such cases, this is specified in the class documentation.", "default": false } }, "description": "Model containing the method level model for GenericObject.configureInstanceWithResult to decode json data to internal NFM-P object model" } } ], "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": "/restGenericGenericObjectConfigureInstanceWithResult" }, "task": true }, { "name": "restGenericGenericObjectCountInstance", "summary": "countInstance", "description": "Count the number of matched instances of a persisted class. Intention : RETRIEVER countInstance: class-level retriever API countInstance of class generic.GenericObject Returns the number of instances.", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "description": " The full name of the object." }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for GenericObject.countInstance to decode json data to internal NFM-P object model" } } ], "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": "/restGenericGenericObjectCountInstance" }, "task": true }, { "name": "restGenericGenericObjectDeleteInstance", "summary": "rest_generic_GenericObject_deleteInstance", "description": "rest_generic_GenericObject_deleteInstance", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restGenericGenericObjectDeleteInstance" }, "task": true }, { "name": "restGenericGenericObjectFilteredDelete", "summary": "rest_generic_GenericObject_filteredDelete", "description": "rest_generic_GenericObject_filteredDelete", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "description": " Package qualified class namein dot separated format. EXAMPLE:svc.Servicertr.NetworkInterface." }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for GenericObject.filteredDelete to decode json data to internal NFM-P object model" } } ], "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": "/restGenericGenericObjectFilteredDelete" }, "task": true }, { "name": "restGenericGenericObjectFilteredFind", "summary": "filteredFind", "description": "Retrieve a set of matched object(s) with the given instance full name and or its children. Depending on the scope, the set could contain one object or the whole subtree. Example 1 : instanceFullName = \"svc-mgr:service-6\", scopeType = 0, shall return the svc-mgr:service-6 object Example 2 : instanceFullName = \"svc-mgr:service-6\", scopeType = 1, shall return children of svc-mgr:service-6 Example 3 : instanceFullName = \"svc-mgr:service-6\", scopeType = 2, scopeDepth = 2, shall return children a...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"instanceFullName\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"scopeType\": 123, \"scopeDepth\": 123, \"capabillities\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "capabillities", "filter", "instanceFullName", "scopeDepth", "scopeType" ], "properties": { "instanceFullName": { "type": "string", "description": " The instance full name from the matched objects have to be retrieved." }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "scopeType": { "type": "integer", "description": " Scope type.Possible values - 0 (Single Object), 1 (Single Level), 2 (N_Levels, where N = scopeDepth), 3 (Whole Subtree)" }, "scopeDepth": { "type": "integer", "description": " The number of levels to be searched." }, "capabillities": { "type": "array", "description": " Capability ID(s).", "uniqueItems": true, "items": { "type": "integer" } } }, "description": "Model containing the method level model for GenericObject.filteredFind to decode json data to internal NFM-P object model" } } ], "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": "/restGenericGenericObjectFilteredFind" }, "task": true }, { "name": "restGenericGenericObjectFindInstance", "summary": "findInstance", "description": "Find the instance with the given full name. Intention : RETRIEVER findInstance: class-level [object finder] (retriever) API findInstance of class generic.GenericObject Returns the instance.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": false, "schema": { "title": "instanceFullName", "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": "/restGenericGenericObjectFindInstance" }, "task": true }, { "name": "restGenericGenericObjectFindMultipleInstances", "summary": "findMultipleInstances", "description": "To find multiple instances with children hierarchy under each instance. An exception log message is recorded in the server log file for any objects, that cannot be found for specified instance names. Intention : RETRIEVER findMultipleInstances: class-level [object finder] (retriever) API findMultipleInstances of class generic.GenericObject List of instances. Note that some classes do not return children. In such cases, this is specified in the class documentation.", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restGenericGenericObjectFindMultipleInstances" }, "task": true }, { "name": "restGenericGenericObjectFindMultipleInstancesShallow", "summary": "findMultipleInstancesShallow", "description": "To find multiple instances without children hierarchy under each instance. Intention : RETRIEVER findMultipleInstancesShallow: class-level [object finder] (retriever) API findMultipleInstancesShallow of class generic.GenericObject list of instances.", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restGenericGenericObjectFindMultipleInstancesShallow" }, "task": true }, { "name": "restGenericGenericObjectForceSubmitDeployer", "summary": "rest_generic_GenericObject_forceSubmitDeployer", "description": "rest_generic_GenericObject_forceSubmitDeployer", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restGenericGenericObjectForceSubmitDeployer" }, "task": true }, { "name": "restGenericGenericObjectGetDeployer", "summary": "getDeployer", "description": "Find information about a specific deployer. Intention : RETRIEVER getDeployer: class-level retriever API getDeployer of class generic.GenericObject Returns the deployer object.", "input": [ { "name": "deployerName", "type": "string", "info": ": string", "required": false, "schema": { "title": "deployerName", "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": "/restGenericGenericObjectGetDeployer" }, "task": true }, { "name": "restGenericGenericObjectGetDeployers", "summary": "getDeployers", "description": "Find information for deployers matching the specified filter with children hierarchy. Intention : RETRIEVER getDeployers: class-level retriever API getDeployers of class generic.GenericObject Returns the list of deployers.", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restGenericGenericObjectGetDeployers" }, "task": true }, { "name": "restGenericGenericObjectGetDeployersShallow", "summary": "getDeployersShallow", "description": "Retrieve matched deployers without children hierarchy. Intention : RETRIEVER getDeployersShallow: class-level retriever API getDeployersShallow of class generic.GenericObject Returns the list of deployers.", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restGenericGenericObjectGetDeployersShallow" }, "task": true }, { "name": "restGenericGenericObjectGetIncrementalRequestID", "summary": "getIncrementalRequestID", "description": "Intention : RETRIEVER getIncrementalRequestID: class-level retriever API getIncrementalRequestID of class generic.GenericObject", "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": "/restGenericGenericObjectGetIncrementalRequestID" }, "task": true }, { "name": "restGenericGenericObjectMultipleFilteredFind", "summary": "multipleFilteredFind", "description": "Retrieve a set of objects matching the specified search criteria with children hierarchy. Intention : RETRIEVER multipleFilteredFind: class-level retriever API multipleFilteredFind of class generic.GenericObject List of objects retrieved.", "input": [ { "name": "body", "type": "object", "info": ": {\"searchCriteria\": [{\"objectClassName\": \"string\", \"instanceFullName\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"scopeType\": 123, \"scopeDepth\": 123}], \"capabillities\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "capabillities", "searchCriteria" ], "properties": { "searchCriteria": { "type": "array", "description": " The search criteria to applied to retrieve the set of objects.", "uniqueItems": true, "items": { "type": "object", "required": [ "filter", "instanceFullName", "objectClassName", "scopeDepth", "scopeType" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "instanceFullName": { "type": "string" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "scopeType": { "type": "integer" }, "scopeDepth": { "type": "integer" } }, "description": "Model containing the method level model for struct InstanceSearchCriteria. to decode json data to internal NFM-P object model" } }, "capabillities": { "type": "array", "description": " Capability ID(s).", "uniqueItems": true, "items": { "type": "integer" } } }, "description": "Model containing the method level model for GenericObject.multipleFilteredFind to decode json data to internal NFM-P object model" } } ], "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": "/restGenericGenericObjectMultipleFilteredFind" }, "task": true }, { "name": "restGenericGenericObjectRemoveMany", "summary": "rest_generic_GenericObject_removeMany", "description": "rest_generic_GenericObject_removeMany", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restGenericGenericObjectRemoveMany" }, "task": true }, { "name": "restGenericGenericObjectResumeDeploymentRetries", "summary": "rest_generic_GenericObject_resumeDeploymentRetries", "description": "rest_generic_GenericObject_resumeDeploymentRetries", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restGenericGenericObjectResumeDeploymentRetries" }, "task": true }, { "name": "restGenericGenericObjectSuspendDeploymentRetries", "summary": "rest_generic_GenericObject_suspendDeploymentRetries", "description": "rest_generic_GenericObject_suspendDeploymentRetries", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restGenericGenericObjectSuspendDeploymentRetries" }, "task": true }, { "name": "restGenericGenericObjectTriggerCollect", "summary": "rest_generic_GenericObject_triggerCollect", "description": "rest_generic_GenericObject_triggerCollect", "input": [ { "name": "body", "type": "object", "info": ": {\"instanceNames\": \"array\", \"currentDataClasses\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "currentDataClasses", "instanceNames" ], "properties": { "instanceNames": { "type": "array", "description": " The object instances (FDNs) to collect statistics on.", "uniqueItems": true, "items": { "type": "string" } }, "currentDataClasses": { "type": "array", "description": " The statistics 'current data' classes to collect for.", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for ResidentialSubscriberManager.triggerCollect to decode json data to internal NFM-P object model" } } ], "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": "/restGenericGenericObjectTriggerCollect" }, "task": true }, { "name": "restGenericGenericObjectTriggerIncrementalRequest", "summary": "triggerIncrementalRequest", "description": "This method starts a request for a specified application. IncrementalRequestEvents are generated for start, incremental, failed and finished states. Intention : RETRIEVER triggerIncrementalRequest: class-level [functionality trigger] (retriever) API triggerIncrementalRequest of class generic.GenericObject The incremental request ID is returned when the request is started. The ID can be used to identify IncrementalRequestEvents for this request.", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"jmsClientId\": \"string\", \"handlerName\": \"string\", \"appDefinedContext\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "appDefinedContext", "handlerName", "jmsClientId", "objectClassName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "jmsClientId": { "type": "string" }, "handlerName": { "type": "string" }, "appDefinedContext": { "type": "object" } }, "description": "Model containing the method level model for struct IncrementalContext. to decode json data to internal NFM-P object model" } } ], "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": "/restGenericGenericObjectTriggerIncrementalRequest" }, "task": true }, { "name": "restGenericGenericObjectTriggerIncrementalRequestWithRequestID", "summary": "rest_generic_GenericObject_triggerIncrementalRequestWithRequestID", "description": "rest_generic_GenericObject_triggerIncrementalRequestWithRequestID", "input": [ { "name": "body", "type": "object", "info": ": {\"aInIncrementalRequestId\": 123, \"aInIncrementalContext\": {\"objectClassName\": \"string\", \"jmsClientId\": \"string\", \"handlerName\": \"string\", \"appDefinedContext\": \"object\"}}", "required": false, "schema": { "type": "object", "properties": { "aInIncrementalRequestId": { "type": "integer" }, "aInIncrementalContext": { "type": "object", "required": [ "appDefinedContext", "handlerName", "jmsClientId", "objectClassName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "jmsClientId": { "type": "string" }, "handlerName": { "type": "string" }, "appDefinedContext": { "type": "object" } }, "description": "Model containing the method level model for struct IncrementalContext. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for GenericObject.triggerIncrementalRequestWithRequestID to decode json data to internal NFM-P object model" } } ], "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": "/restGenericGenericObjectTriggerIncrementalRequestWithRequestID" }, "task": true }, { "name": "restGenericGenericObjectTriggerResync", "summary": "triggerResync", "description": "To perform a non-scheduled resynchronization of an object. The resynch request will not return until all related resync tasks have completed. Intention : RETRIEVER triggerResync: class-level [functionality trigger] (retriever) API triggerResync of class generic.GenericObject Resulting status of the resync, as defined in taskmgmt.TaskStatus", "input": [ { "name": "body", "type": "object", "info": ": {\"instanceName\": \"string\", \"resyncSelf\": \"boolean\", \"resyncChildren\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "instanceName", "resyncChildren", "resyncSelf" ], "properties": { "instanceName": { "type": "string", "description": " The name of the instance to be resynched." }, "resyncSelf": { "type": "boolean", "description": " Specifies if the object has to be resynched.", "default": false }, "resyncChildren": { "type": "boolean", "description": " Specifies if children need to be resynched.", "default": false } }, "description": "Model containing the method level model for GenericObject.triggerResync to decode json data to internal NFM-P object model" } } ], "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": "/restGenericGenericObjectTriggerResync" }, "task": true }, { "name": "restGenericGenericObjectUpdateUserObjectLifecycleStates", "summary": "updateUserObjectLifecycleStates", "description": "Set user OLC States. Intention : MODIFIER updateUserObjectLifecycleStates: class-level modifier API updateUserObjectLifecycleStates of class generic.GenericObject", "input": [ { "name": "body", "type": "object", "info": ": {\"distinguishedName\": \"string\", \"anInOLCState\": 123}", "required": false, "schema": { "type": "object", "required": [ "anInOLCState", "distinguishedName" ], "properties": { "distinguishedName": { "type": "string", "description": " Distinguished Name of object being configured." }, "anInOLCState": { "type": "integer", "description": " " } }, "description": "Model containing the method level model for GenericObject.updateUserObjectLifecycleStates to decode json data to internal NFM-P object model" } } ], "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": "/restGenericGenericObjectUpdateUserObjectLifecycleStates" }, "task": true }, { "name": "restGenericGenericObjectUpdateUserObjectLifecycleStatesAndLocks", "summary": "updateUserObjectLifecycleStatesAndLocks", "description": "Set user OLC States. Intention : MODIFIER updateUserObjectLifecycleStatesAndLocks: class-level modifier API updateUserObjectLifecycleStatesAndLocks of class generic.GenericObject", "input": [ { "name": "body", "type": "object", "info": ": {\"distinguishedName\": \"string\", \"anInOLCState\": 123, \"anInLockOLCState\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "anInLockOLCState", "anInOLCState", "distinguishedName" ], "properties": { "distinguishedName": { "type": "string", "description": " Distinguished Name of object being configured." }, "anInOLCState": { "type": "integer", "description": " The target OLC State." }, "anInLockOLCState": { "type": "boolean", "description": " The target Lock OLC State.", "default": false } }, "description": "Model containing the method level model for GenericObject.updateUserObjectLifecycleStatesAndLocks to decode json data to internal NFM-P object model" } } ], "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": "/restGenericGenericObjectUpdateUserObjectLifecycleStatesAndLocks" }, "task": true }, { "name": "restGenericGenericObjectUpdateUserObjectLifecycleStatesAndLocksAndSchedules", "summary": "updateUserObjectLifecycleStatesAndLocksAndSchedules", "description": "Set user OLC Schedule. Intention : MODIFIER updateUserObjectLifecycleStatesAndLocksAndSchedules: class-level modifier API updateUserObjectLifecycleStatesAndLocksAndSchedules of class generic.GenericObject", "input": [ { "name": "body", "type": "object", "info": ": {\"distinguishedName\": \"string\", \"anInFlipTimeSelected\": 123, \"anInCurrentOLCState\": 123, \"anInCurrentLockOLCState\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "anInCurrentLockOLCState", "anInCurrentOLCState", "anInFlipTimeSelected", "distinguishedName" ], "properties": { "distinguishedName": { "type": "string", "description": " Distinguished Name of object being configured." }, "anInFlipTimeSelected": { "type": "integer", "description": " The time in milliseconds that OLC State will be flipped." }, "anInCurrentOLCState": { "type": "integer", "description": " The target OLC State to set before the schedule." }, "anInCurrentLockOLCState": { "type": "boolean", "description": " The target Lock OLC State to set before the schedule.", "default": false } }, "description": "Model containing the method level model for GenericObject.updateUserObjectLifecycleStatesAndLocksAndSchedules to decode json data to internal NFM-P object model" } } ], "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": "/restGenericGenericObjectUpdateUserObjectLifecycleStatesAndLocksAndSchedules" }, "task": true }, { "name": "restGenericGenericObjectUpdateUserObjectLifecycleStatesAndSchedules", "summary": "updateUserObjectLifecycleStatesAndSchedules", "description": "Set user OLC Schedule. Intention : MODIFIER updateUserObjectLifecycleStatesAndSchedules: class-level modifier API updateUserObjectLifecycleStatesAndSchedules of class generic.GenericObject", "input": [ { "name": "body", "type": "object", "info": ": {\"distinguishedName\": \"string\", \"anInFlipTimeSelected\": 123, \"anInCurrentOLCState\": 123}", "required": false, "schema": { "type": "object", "required": [ "anInCurrentOLCState", "anInFlipTimeSelected", "distinguishedName" ], "properties": { "distinguishedName": { "type": "string", "description": " Distinguished Name of object being configured." }, "anInFlipTimeSelected": { "type": "integer", "description": " The time in milliseconds that OLC State will be flipped." }, "anInCurrentOLCState": { "type": "integer", "description": " The target OLC State to set before the schedule." } }, "description": "Model containing the method level model for GenericObject.updateUserObjectLifecycleStatesAndSchedules to decode json data to internal NFM-P object model" } } ], "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": "/restGenericGenericObjectUpdateUserObjectLifecycleStatesAndSchedules" }, "task": true }, { "name": "restGenericneGenericNeProfileConfigure", "summary": "configure", "description": "This method is used to modify a Generic NE Profile. Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class genericne.GenericNeProfile This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object Object Full name of Generic NE Profile that is modified.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restGenericneGenericNeProfileConfigure" }, "task": true }, { "name": "restGenericneGenericNeProfileFindScripts", "summary": "findScripts", "description": "Intention : RETRIEVER findScripts: class-level [object finder] (retriever) API findScripts of class genericne.GenericNeProfile", "input": [ { "name": "productName", "type": "string", "info": ": string", "required": false, "schema": { "title": "productName", "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": "/restGenericneGenericNeProfileFindScripts" }, "task": true }, { "name": "restGenericneGenericNeProfileValidateUpgradePath", "summary": "validateUpgradePath", "description": "This method is used to validate the changing of the Driver Module. Intention : RETRIEVER validateUpgradePath: class-level retriever API validateUpgradePath of class genericne.GenericNeProfile Upgrade result returned if specified in descriptor.xml", "input": [ { "name": "body", "type": "object", "info": ": {\"genericNeProfile\": \"string\", \"oldDescriptorPointer\": \"string\", \"newDescriptorPointer\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "genericNeProfile", "newDescriptorPointer", "oldDescriptorPointer" ], "properties": { "genericNeProfile": { "type": "string", "description": " " }, "oldDescriptorPointer": { "type": "string", "description": " " }, "newDescriptorPointer": { "type": "string", "description": " " } }, "description": "Model containing the method level model for GenericNeProfile.validateUpgradePath to decode json data to internal NFM-P object model" } } ], "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": "/restGenericneGenericNeProfileValidateUpgradePath" }, "task": true }, { "name": "restGenericneGenericNeProfileManagerConfigure", "summary": "configure", "description": "This method is used to create and configure a Generic NE Profile. Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure on default instance genericne-profile-manager of class genericne.GenericNeProfileManager This API follows hierarchical config model rules. The object full name of the Generic NE Profile (created or configured).", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restGenericneGenericNeProfileManagerConfigure" }, "task": true }, { "name": "restGenericneGenericNeProfileManagerGetNesMultipleTypes", "summary": "getNesMultipleTypes", "description": "Return all NEs for the given NE Types. Intention : RETRIEVER getNesMultipleTypes: class-level retriever API getNesMultipleTypes on default instance genericne-profile-manager of class genericne.GenericNeProfileManager List of NE Infos for the given NE type.", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restGenericneGenericNeProfileManagerGetNesMultipleTypes" }, "task": true }, { "name": "restGmplsuniGmplsLspFindTunnelGroupEndpointMembers", "summary": "findTunnelGroupEndpointMembers", "description": "Finds all tunnel group endpoint members associated with this UNI GLSP. Intention : RETRIEVER findTunnelGroupEndpointMembers: instance-level [object finder] (retriever) API findTunnelGroupEndpointMembers of class gmplsuni.GmplsLsp instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"tunnelGroupEndpointMemberFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"tunnelGroupEndpointFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "tunnelGroupEndpointFilter", "tunnelGroupEndpointMemberFilter" ], "properties": { "tunnelGroupEndpointMemberFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "tunnelGroupEndpointFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for GmplsLsp.findTunnelGroupEndpointMembers to decode json data to internal NFM-P object model" } } ], "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": "/restGmplsuniGmplsLspFindTunnelGroupEndpointMembers" }, "task": true }, { "name": "restGmplsuniProvisionedPathFindGLSPs", "summary": "findGLSPs", "description": "Finds all UNI GLSPs associated with this GMPLS provisioned path. Intention : RETRIEVER findGLSPs: instance-level [object finder] (retriever) API findGLSPs of class gmplsuni.ProvisionedPath instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"lspPathFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"lspFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "lspFilter", "lspPathFilter" ], "properties": { "lspPathFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "lspFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for ProvisionedPath.findGLSPs to decode json data to internal NFM-P object model" } } ], "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": "/restGmplsuniProvisionedPathFindGLSPs" }, "task": true }, { "name": "restGmplsuniTunnelGroupEndpointMemberNavigateToFarEndMember", "summary": "navigateToFarEndMember", "description": "Returns the FDN of the far-end member (the one with the same session name), or \"\" if the far-end member is not configured. Intention : RETRIEVER navigateToFarEndMember: instance-level retriever API navigateToFarEndMember of class gmplsuni.TunnelGroupEndpointMember instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restGmplsuniTunnelGroupEndpointMemberNavigateToFarEndMember" }, "task": true }, { "name": "restGtpS11SessionRetrieveGtpS11Sessions", "summary": "retrieveGtpS11Sessions", "description": "Method used to retrieve GTP S11 sessions from NE. Intention : RETRIEVER retrieveGtpS11Sessions: class-level retriever API retrieveGtpS11Sessions of class gtp.S11Session", "input": [ { "name": "body", "type": "object", "info": ": {\"aInRetrGtpS11SessionStruct\": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"imsi\": \"string\", \"apn\": \"string\", \"timeout\": 123}, \"retrieveBearers\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "retrieveBearers" ], "properties": { "aInRetrGtpS11SessionStruct": { "type": "object", "required": [ "apn", "imsi", "objectClassName", "siteId", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "imsi": { "type": "string" }, "apn": { "type": "string" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct RetrGtpS11SessionStruct. to decode json data to internal NFM-P object model" }, "retrieveBearers": { "type": "boolean", "description": " Specifies if the Bearers should be retrieved,the default is \"false\".If true, the Bearers are retrieved for the GTP S11 Session.If false, the Bearers are not retrieved for the GTP S11 Session. default:false", "default": false } }, "description": "Model containing the method level model for S11Session.retrieveGtpS11Sessions to decode json data to internal NFM-P object model" } } ], "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": "/restGtpS11SessionRetrieveGtpS11Sessions" }, "task": true }, { "name": "restHsmHSMConfigForceDelete", "summary": "rest_hsm_HSMConfig_forceDelete", "description": "rest_hsm_HSMConfig_forceDelete", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restHsmHSMConfigForceDelete" }, "task": true }, { "name": "restHsmHSMConfigPurgeStaleEntriesOnHsm", "summary": "purgeStaleEntriesOnHsm", "description": "Purge stale (non-referenced) entries, that were created through this HSMConfig, on the HSM. Please note, HSM entries are identified by their labels. Normally NFM-P deletes an entry from the HSM if it is no longer needed. However if the deletion fails the entry may become stale on the HSM. Stale entries in this HSMConfig need to be purged on the HSM explicitly through this method call. Intention : MODIFIER purgeStaleEntriesOnHsm: instance-level modifier API purgeStaleEntriesOnHsm of class ...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restHsmHSMConfigPurgeStaleEntriesOnHsm" }, "task": true }, { "name": "restHsmHSMConfigTestConnectionToHsm", "summary": "testConnectionToHsm", "description": "Test the connection to the HSM. This method sends a test request to the HSM. Intention : MODIFIER testConnectionToHsm: instance-level modifier API testConnectionToHsm of class hsm.HSMConfig instanceFullName : distinguished/instance name of called object True if the test request was successfully executed; false otherwise.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restHsmHSMConfigTestConnectionToHsm" }, "task": true }, { "name": "restIcmpIcmpPingCancelIcmpTest", "summary": "rest_icmp_IcmpPing_cancelIcmpTest", "description": "rest_icmp_IcmpPing_cancelIcmpTest", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restIcmpIcmpPingCancelIcmpTest" }, "task": true }, { "name": "restIesGroupInterfaceRequestPolicyAccountStatsClear", "summary": "requestPolicyAccountStatsClear", "description": "Request clearing of Policy Accounting Statistics on this interface. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestPolicyAccountStatsClear: instance-level modifier API requestPolicyAccountStatsClear of class ies.GroupInterface instanceFullName : disti...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInAcctType\": 123, \"aInAcctIndex\": 123, \"aInClearAll\": \"boolean\"}", "required": false, "schema": { "type": "object", "properties": { "aInAcctType": { "type": "integer" }, "aInAcctIndex": { "type": "integer" }, "aInClearAll": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for NetworkInterface.requestPolicyAccountStatsClear to decode json data to internal NFM-P object model" } } ], "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": "/restIesGroupInterfaceRequestPolicyAccountStatsClear" }, "task": true }, { "name": "restIesL3AccessInterfaceRequestPolicyAccountStatsClear", "summary": "requestPolicyAccountStatsClear", "description": "Request clearing of Policy Accounting Statistics on this interface. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestPolicyAccountStatsClear: instance-level modifier API requestPolicyAccountStatsClear of class ies.L3AccessInterface instanceFullName : di...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInAcctType\": 123, \"aInAcctIndex\": 123, \"aInClearAll\": \"boolean\"}", "required": false, "schema": { "type": "object", "properties": { "aInAcctType": { "type": "integer" }, "aInAcctIndex": { "type": "integer" }, "aInClearAll": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for NetworkInterface.requestPolicyAccountStatsClear to decode json data to internal NFM-P object model" } } ], "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": "/restIesL3AccessInterfaceRequestPolicyAccountStatsClear" }, "task": true }, { "name": "restIesMSapRequestClearMsap", "summary": "requestClearMsap", "description": "Request clearing of this MSAP. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearMsap: instance-level modifier API requestClearMsap of class ies.MSap instanceFullName : distinguished/instance name of called object A request handle which allows the r...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restIesMSapRequestClearMsap" }, "task": true }, { "name": "restIesServiceAccessPointRequestClearIgmpHostTracking", "summary": "requestClearIgmpHostTracking", "description": "Request clearing of all IGMP Host Tracking information for this ServiceAccessPoint. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearIgmpHostTracking: instance-level modifier API requestClearIgmpHostTracking of class ies.ServiceAccessPoint Descenda...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restIesServiceAccessPointRequestClearIgmpHostTracking" }, "task": true }, { "name": "restIesSiteRequestClearIgmpHostTracking", "summary": "requestClearIgmpHostTracking", "description": "Request clearing of all IGMP Host Tracking information for this site. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearIgmpHostTracking: instance-level modifier API requestClearIgmpHostTracking of class ies.Site instanceFullName : distinguished/ins...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restIesSiteRequestClearIgmpHostTracking" }, "task": true }, { "name": "restIghInterfaceGroupHandlerConfigureIghMember", "summary": "configureIghMember", "description": "This API can be used to create IghMembers . Intention : MODIFIER configureIghMember: instance-level [hierarchical administrative configuration/modification] (modifier) API configureIghMember of class igh.InterfaceGroupHandler This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object DN of successfully created IghMember", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"parentDN\": \"string\", \"portPointer\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "objectClassName", "parentDN", "portPointer" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "parentDN": { "type": "string" }, "portPointer": { "type": "string" } }, "description": "Model containing the method level model for struct IGHMemCreateInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restIghInterfaceGroupHandlerConfigureIghMember" }, "task": true }, { "name": "restIgmpGroupInterfaceSapGroupRetrieveIgmpGroupIfSapGrp", "summary": "retrieveIgmpGroupIfSapGrp", "description": "Method used to query the NE for group address entries under a GroupInterfaceSap. Intention : RETRIEVER retrieveIgmpGroupIfSapGrp: class-level retriever API retrieveIgmpGroupIfSapGrp of class igmp.GroupInterfaceSapGroup", "input": [ { "name": "body", "type": "object", "info": ": {\"aInFwdServiceId\": 123, \"aInGrpIfindex\": 123, \"aInEncapVal\": 123, \"aInSiteId\": \"string\", \"aInRouterId\": 123, \"aInPortId\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInFwdServiceId": { "type": "integer" }, "aInGrpIfindex": { "type": "integer" }, "aInEncapVal": { "type": "integer" }, "aInSiteId": { "type": "string" }, "aInRouterId": { "type": "integer" }, "aInPortId": { "type": "integer" } }, "description": "Model containing the method level model for GroupInterfaceSapGroup.retrieveIgmpGroupIfSapGrp to decode json data to internal NFM-P object model" } } ], "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": "/restIgmpGroupInterfaceSapGroupRetrieveIgmpGroupIfSapGrp" }, "task": true }, { "name": "restIgmpGroupInterfaceSapGroupSourceRetrieveIgmpGroupIfSapGrpSrc", "summary": "retrieveIgmpGroupIfSapGrpSrc", "description": "Method used to query the NE for source address entries under a GroupInterfaceSapGroup. Intention : RETRIEVER retrieveIgmpGroupIfSapGrpSrc: class-level retriever API retrieveIgmpGroupIfSapGrpSrc of class igmp.GroupInterfaceSapGroupSource", "input": [ { "name": "body", "type": "object", "info": ": {\"aInFwdServiceId\": 123, \"aInGrpIfindex\": 123, \"aInEncapVal\": 123, \"aInGroupAddress\": \"string\", \"aInSiteId\": \"string\", \"aInRouterId\": 123, \"aInPortId\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInFwdServiceId": { "type": "integer" }, "aInGrpIfindex": { "type": "integer" }, "aInEncapVal": { "type": "integer" }, "aInGroupAddress": { "type": "string" }, "aInSiteId": { "type": "string" }, "aInRouterId": { "type": "integer" }, "aInPortId": { "type": "integer" } }, "description": "Model containing the method level model for GroupInterfaceSapGroupSource.retrieveIgmpGroupIfSapGrpSrc to decode json data to internal NFM-P object model" } } ], "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": "/restIgmpGroupInterfaceSapGroupSourceRetrieveIgmpGroupIfSapGrpSrc" }, "task": true }, { "name": "restIgmpIgmpHostRetrieveIgmpHosts", "summary": "retrieveIgmpHosts", "description": "Method used to query the network element for IGMP hosts and their IGMP Groups-Sources associated with a specified subscriber; Bandwidth will be calculated if MCAC Policy is specified. Intention : RETRIEVER retrieveIgmpHosts: class-level retriever API retrieveIgmpHosts of class igmp.IgmpHost", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInSubId\": \"string\", \"aInMCacPolicyPointer\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInSubId": { "type": "string" }, "aInMCacPolicyPointer": { "type": "string" } }, "description": "Model containing the method level model for IgmpHost.retrieveIgmpHosts to decode json data to internal NFM-P object model" } } ], "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": "/restIgmpIgmpHostRetrieveIgmpHosts" }, "task": true }, { "name": "restIgmpSiteConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class igmp.Site This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restIgmpSiteConfigure" }, "task": true }, { "name": "restIpipeSiteRequestClearArpCache", "summary": "requestClearArpCache", "description": "Request clearing the ARP cache for this site. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearArpCache: instance-level modifier API requestClearArpCache of class ipipe.Site instanceFullName : distinguished/instance name of called object A request ...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restIpipeSiteRequestClearArpCache" }, "task": true }, { "name": "restIpipeSiteRequestClearNeighborCache", "summary": "requestClearNeighborCache", "description": "Request clearing the discovered IPv6 neighbor cache for this site. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearNeighborCache: instance-level modifier API requestClearNeighborCache of class ipipe.Site instanceFullName : distinguished/instance n...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restIpipeSiteRequestClearNeighborCache" }, "task": true }, { "name": "restIpsecIPSecGatewayShutDown", "summary": "rest_ipsec_IPSecGateway_shutDown", "description": "rest_ipsec_IPSecGateway_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restIpsecIPSecGatewayShutDown" }, "task": true }, { "name": "restIpsecIPSecGatewayTurnUp", "summary": "rest_ipsec_IPSecGateway_turnUp", "description": "rest_ipsec_IPSecGateway_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restIpsecIPSecGatewayTurnUp" }, "task": true }, { "name": "restIpsecIPSecSecuredVpnManagerConfigureIPSecSecuredVPN", "summary": "configureIPSecSecuredVPN", "description": "Intention : MODIFIER configureIPSecSecuredVPN: instance-level [hierarchical administrative configuration/modification] (modifier) API configureIPSecSecuredVPN on default instance isv-mgr of class ipsec.IPSecSecuredVpnManager This API follows hierarchical config model rules.", "input": [ { "name": "body", "type": "object", "info": ": {\"ipsecSecuredCtdInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"id\": 123, \"displayedName\": \"string\", \"description\": \"string\", \"serviceType\": 123, \"corporateServiceId\": 123, \"corporateServicePointer\": \"string\", \"privateServicePointer\": \"string\", \"corporateToSecureServiceConnector\": 123, \"ipsecSecurityPolicy\": \"boolean\", \"replayWindow\": 123, \"keying\": 123, \"ikePolicyPointer\": \"string\", \"preSharedKey\": \"string\", \"tunnelTemplatePointer\": \"string\", \"ipsecTransformPointer\": \"string\", \"autoEstablish\": \"boolean\", \"createCompositeService\": \"boolean\", \"keyTypeOptionInbound\": 123, \"encryptionKeyInbound\": \"string\", \"authenticationKeyInbound\": \"string\", \"spiInbound\": 123, \"keyTypeOptionOutbound\": 123, \"encryptionKeyOutbound\": \"string\", \"authenticationKeyOutbound\": \"string\", \"spiOutbound\": 123, \"subscrAuthPolicyPointer\": \"string\", \"ikePolicyPointerSoftClient\": \"string\", \"certTrustAnchorPointer\": \"string\", \"certFile\": \"string\", \"keyFile\": \"string\", \"localIdType\": 123, \"localIdValue\": \"string\"}, \"privateService\": {\"objectClassName\": \"string\", \"service\": {\"objectClassName\": \"string\", \"serviceId\": 123, \"ctdMap\": \"object\"}, \"siteList\": [{\"objectClassName\": \"string\", \"siteId\": \"string\", \"ctdMap\": \"object\", \"accessInterface\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\"}, \"staticRoute\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\"}}]}, \"publicServices\": [{\"objectClassName\": \"string\", \"service\": {\"objectClassName\": \"string\", \"serviceId\": 123, \"ctdMap\": \"object\"}, \"siteList\": [{\"objectClassName\": \"string\", \"siteId\": \"string\", \"ctdMap\": \"object\", \"accessInterface\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\"}, \"staticRoute\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\"}}]}], \"l3IpSecPairs\": [{\"objectClassName\": \"string\", \"firstObject\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"urpfcheckState\": 123, \"urpfcheckMode\": 123, \"urpfcheckStateIpv6\": 123, \"urpfcheckModeIpv6\": 123, \"diconX\": 123, \"diconY\": 123, \"dcpuProtectionPolicyPointer\": \"string\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"displayedName\": \"string\", \"description\": \"string\", \"encapType\": 123, \"administrativeState\": 123, \"portPointer\": \"string\", \"innerEncapValue\": 123, \"outerEncapValue\": 123, \"reassembly\": \"boolean\", \"dIconX\": 123, \"dIconY\": 123, \"ingressPolicyObjectPointer\": \"string\", \"egressPolicyObjectPointer\": \"string\", \"aggregation\": 123, \"ingressSchedulerObjectPointer\": \"string\", \"egressSchedulerObjectPointer\": \"string\", \"aggregationSchedulerObjectPointer\": \"string\", \"ingressFilterPointer\": \"string\", \"ingressMatchQinqDot1pBits\": 123, \"egressQinqMarkTopBitsOnly\": \"boolean\", \"egressFilterPointer\": \"string\", \"ingressIpv6FilterPointer\": \"string\", \"egressIpv6FilterPointer\": \"string\", \"accountingPolicyObjectPointer\": \"string\", \"accountingOn\": \"boolean\", \"ingressPolicerAccountingOn\": \"boolean\", \"egressQueueAccountingOn\": \"boolean\", \"sharedQueueOn\": \"boolean\", \"hsmdaEgrSecondaryShaper\": \"string\", \"hsmdaEgrQosPackByteOffOvrd\": 123, \"egressAggRateLimit\": 123, \"ingressAggRateLimit\": 123, \"egressAggCIR\": 123, \"ingressAggCIR\": 123, \"egressSchedulerMode\": 123, \"ingressSchedulerMode\": 123, \"egressFrameBaseAccounting\": \"boolean\", \"dosProtection\": \"string\", \"dCpuProtectionPolicyPointer\": \"string\", \"ingressPolicerPolicyPointer\": \"string\", \"egressPolicerPolicyPointer\": \"string\", \"sapEgressStatsPktsMode\": \"boolean\", \"sapIngressCounterMode\": 123, \"sapIngressCounterType\": 123, \"sapEgressStatsEnable\": \"boolean\", \"sapIngressStatsEnable\": \"boolean\", \"transitIpPolicyPointer\": \"string\", \"transitPrefixPolicyPointer\": \"string\", \"hsmdaEgrQosWrrPlcyOvrd\": \"string\", \"ingressQueueGroupName\": \"string\", \"ingressRedirectListQueueGroup\": \"string\", \"egressRedirectListQueueGroup\": \"string\", \"ingressInstanceId\": 123, \"egressPortQueueGroupPointer\": \"string\", \"egressPortQueueGroupName\": \"string\", \"egressPortQueueInstanceId\": 123, \"aarpPointer\": \"string\", \"aarpServRefType\": 123, \"egressAggRateLUB\": \"boolean\", \"egressAggRateLimitEnabled\": \"boolean\", \"egressAggRateLimitCIR\": 123, \"egressAggRateLimitPIR\": 123, \"macLearnOptions\": 123, \"egressShaperGrpPointer\": \"string\", \"ingressShaperGrpPointer\": \"string\", \"sapIngressAggregateShaperRate\": 123, \"sapEgressAggregateShaperRate\": 123, \"hsEgrSecondaryShaper\": \"string\", \"egressRemarkingPolicyObjectPointer\": \"string\", \"egressRemarkPolicyObjectPointer\": \"string\", \"egressVlanQosPolicyObjectPointer\": \"string\", \"mprvlanId\": 123, \"pmonPolicy\": \"string\", \"lockOlcState\": \"boolean\", \"templateVersionPointer\": \"string\", \"id\": 123, \"sapIngressAggregateShaperRateCIR\": 123, \"sapIngressAggregateShaperRatePIR\": 123, \"physicalAddress\": \"string\", \"interfaceClass\": 123, \"unnumberedReferenceType\": 123, \"unnumberedReference\": \"string\", \"directedBroadcast\": \"boolean\", \"isTrusted\": 123, \"loopbackEnabled\": \"boolean\", \"l3InterfaceDescription\": \"string\", \"l3InterfaceAdministrativeState\": 123, \"shcvSource\": 123, \"shcvAction\": 123, \"shcvInterval\": 123, \"shcvRetryTimeout\": 123, \"shcvRetryCount\": 123, \"usesMultipointShared\": 123, \"todSuitePointer\": \"string\", \"unnumberedInterfaceName\": \"string\", \"unnumberedIpAddress\": \"string\", \"ipMtu\": 123, \"localDhcpServerPointer\": \"string\", \"localDhcpServerName\": \"string\", \"aaApplicationProfile\": \"string\", \"callingStationId\": \"string\", \"uRPFCheckState\": 123, \"uRPFCheckMode\": 123, \"uRPFCheckStateIpv6\": 123, \"uRPFCheckModeIpv6\": 123, \"aaGrpId\": 123, \"aaPartId\": 123, \"l3dosProtection\": \"string\", \"macMonitoring\": \"boolean\", \"ipMonitoring\": \"boolean\", \"cpmProtEthCfmMonitorFlags\": 123, \"vplsName\": \"string\", \"vplsEgressQosPolicyPointer\": \"string\", \"vplsIngressIPv4FilterPointer\": \"string\", \"vplsIngressIPv6FilterPointer\": \"string\", \"vplsEgressIPv4FilterPointer\": \"string\", \"vplsEgressIPv6FilterPointer\": \"string\", \"localDhcp6ServerPointer\": \"string\", \"monitorOperGroupName\": \"string\", \"monitorOperGroupPtr\": \"string\", \"qosRouteLookupIpv4\": 123, \"qosRouteLookupIpv6\": 123, \"sasIngressPolicyObjectPointer\": \"string\", \"sapIngressAggregateMeterRate\": 123, \"sapIngressAggregateMeterBurst\": 123, \"sapIngressWithAggregateMeter\": 123, \"sapIngressAggregateMeterCIR\": 123, \"sapIngressAggregateMeterCBS\": 123, \"sapEgressAggregateMeterBurst\": 123, \"sapEgressAggregateMeterEnableStats\": 123, \"sapEgressAggregateMeterRate\": 123, \"sasEgressPolicyObjectPointer\": \"string\", \"radiusProxyServerPointer\": \"string\", \"globalIfIndex\": 123, \"hostLockoutPolicyPointer\": \"string\", \"enableIngressStats\": \"boolean\", \"lagLinkMapProfilePointer\": \"string\", \"ingressFlowspec\": \"boolean\", \"ingressIPv6Flowspec\": \"boolean\", \"staticTnlRedNHAddrType\": 123, \"staticTnlRedNHAddr\": \"string\", \"dynamicTnlRedNHAddrType\": 123, \"dynamicTnlRedNHAddr\": \"string\", \"enableMacAccountingStats\": \"boolean\", \"aluIfL4LoadBalancing\": 123, \"ifTeIdLoadBalancing\": \"boolean\", \"egrIpLoadBalancing\": 123, \"spiLoadBalancing\": \"boolean\", \"ipv6FlowLabelHashing\": \"boolean\", \"securityPolicyBypass\": \"boolean\", \"zonePointer\": \"string\", \"zoneId\": 123, \"policyAccountingTemplatePointer\": \"string\", \"sharedRiskLinkGroupPointers\": \"array\", \"adminGroupInclude\": 123, \"shcvPolicyIPv4Pointer\": \"string\", \"ipv6Allowed\": \"boolean\", \"vasIfType\": 123, \"ipv6NeighborLimit\": 123, \"ipv6NeighborLogOnly\": \"boolean\", \"ipv6NeighborThreshold\": 123, \"bandwidth\": 123, \"bandwidthHi\": 123, \"ignoreSapPortState\": 123, \"schedulerPolicyObjectPointer\": \"string\", \"arpLearnUnsolicited\": \"boolean\", \"arpPopulateHostRoute\": \"boolean\", \"arpRouteTag\": \"string\", \"neighbhorPopulateHostRoute\": \"boolean\", \"neighbhorRouteTag\": \"string\", \"arpProactiveRefresh\": \"boolean\", \"neighborLearnUnsolicited\": 123, \"neighborProactiveRefresh\": 123, \"enableTableClassification\": \"boolean\", \"enableTableClassificationForRvpls\": \"boolean\", \"routedOverrideQosPolicyPointer\": \"string\", \"forwardIPv4Packets\": \"boolean\", \"arpLearnDynamic\": \"boolean\", \"ndLearnDynamic\": \"boolean\", \"floodGarpAndUnknownReq\": \"boolean\", \"ipCriteriaOverrideTag\": 123, \"ipv6CriteriaOverrideTag\": 123, \"ingrDestinationClassLookup\": \"boolean\", \"overrides\": \"object\"}, \"secondObject\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"pmtuDiscoveryAging\": 123, \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"serviceIdPointer\": \"string\", \"adminState\": 123, \"certTrustAnchorPointer\": \"string\", \"gwAddressType\": 123, \"gwIpAddress\": \"string\", \"ikePolicyPointer\": \"string\", \"preSharedKey\": \"string\", \"certFile\": \"string\", \"keyFile\": \"string\", \"certProfilePointer\": \"string\", \"trustAnchorProfilePointer\": \"string\", \"defaultResult\": 123, \"primary\": 123, \"secondary\": 123, \"localIdType\": 123, \"localIdValue\": \"string\", \"description\": \"string\", \"dynamicKeyTransformId1Pointer\": \"string\", \"dynamicKeyTransformId2Pointer\": \"string\", \"dynamicKeyTransformId3Pointer\": \"string\", \"dynamicKeyTransformId4Pointer\": \"string\", \"replayWindow\": 123, \"tunnelName\": \"string\", \"remoteAddressType\": 123, \"remoteIpAddress\": \"string\", \"securityPolicyPointer\": \"string\", \"keying\": 123, \"autoEstablish\": \"boolean\", \"bfdDesignate\": \"boolean\", \"bfdEnable\": \"boolean\", \"ipMtu\": 123, \"encapsulatedIpMtu\": 123, \"clearDfBit\": \"boolean\", \"copyDfBit\": \"boolean\", \"icmp6Pkt2Big\": \"boolean\", \"icmp6NumPkt2Big\": 123, \"icmp6Pkt2BigTime\": 123, \"publicTcpMssAdjust\": 123, \"privateTcpMssAdjust\": 123, \"secPlcyStrictMatch\": \"boolean\", \"propogatePMtuV4\": \"boolean\", \"propogatePMtuV6\": \"boolean\", \"icmpFragReq\": \"boolean\", \"icmpFragReqNum\": 123, \"icmpFragReqTime\": 123, \"pMtuDiscoveryAging\": 123, \"copyTrafficClass\": \"boolean\", \"creationOrigin\": 123}}]}", "required": false, "schema": { "type": "object", "required": [ "ipsecSecuredCtdInfo", "l3IpSecPairs", "privateService", "publicServices" ], "properties": { "ipsecSecuredCtdInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "id": { "type": "integer" }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "serviceType": { "type": "integer" }, "corporateServiceId": { "type": "integer" }, "corporateServicePointer": { "type": "string" }, "privateServicePointer": { "type": "string" }, "corporateToSecureServiceConnector": { "type": "integer" }, "ipsecSecurityPolicy": { "type": "boolean", "default": false }, "replayWindow": { "type": "integer" }, "keying": { "type": "integer" }, "ikePolicyPointer": { "type": "string" }, "preSharedKey": { "type": "string" }, "tunnelTemplatePointer": { "type": "string" }, "ipsecTransformPointer": { "type": "string" }, "autoEstablish": { "type": "boolean", "default": false }, "createCompositeService": { "type": "boolean", "default": false }, "keyTypeOptionInbound": { "type": "integer" }, "encryptionKeyInbound": { "type": "string" }, "authenticationKeyInbound": { "type": "string" }, "spiInbound": { "type": "integer" }, "keyTypeOptionOutbound": { "type": "integer" }, "encryptionKeyOutbound": { "type": "string" }, "authenticationKeyOutbound": { "type": "string" }, "spiOutbound": { "type": "integer" }, "subscrAuthPolicyPointer": { "type": "string" }, "ikePolicyPointerSoftClient": { "type": "string" }, "certTrustAnchorPointer": { "type": "string" }, "certFile": { "type": "string" }, "keyFile": { "type": "string" }, "localIdType": { "type": "integer" }, "localIdValue": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo IPSecSecuredVpnConfigInfo. to decode json data to internal NFM-P object model" }, "privateService": { "type": "object", "required": [ "objectClassName", "service", "siteList" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "service": { "type": "object", "required": [ "ctdMap", "objectClassName", "serviceId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "serviceId": { "type": "integer" }, "ctdMap": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } } }, "description": "Model containing the method level model for struct ServiceUnion. to decode json data to internal NFM-P object model" }, "siteList": { "type": "array", "items": { "type": "object", "required": [ "accessInterface", "ctdMap", "objectClassName", "siteId", "staticRoute" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "ctdMap": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "accessInterface": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" }, "staticRoute": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for struct SiteUnion. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct ServiceSiteStruct. to decode json data to internal NFM-P object model" }, "publicServices": { "type": "array", "description": " ", "items": { "type": "object", "required": [ "objectClassName", "service", "siteList" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "service": { "type": "object", "required": [ "ctdMap", "objectClassName", "serviceId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "serviceId": { "type": "integer" }, "ctdMap": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } } }, "description": "Model containing the method level model for struct ServiceUnion. to decode json data to internal NFM-P object model" }, "siteList": { "type": "array", "items": { "type": "object", "required": [ "accessInterface", "ctdMap", "objectClassName", "siteId", "staticRoute" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "ctdMap": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "accessInterface": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" }, "staticRoute": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for struct SiteUnion. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct ServiceSiteStruct. to decode json data to internal NFM-P object model" } }, "l3IpSecPairs": { "type": "array", "description": " ", "items": { "type": "object", "required": [ "firstObject", "objectClassName", "secondObject" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "firstObject": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "urpfcheckState": { "type": "integer" }, "urpfcheckMode": { "type": "integer" }, "urpfcheckStateIpv6": { "type": "integer" }, "urpfcheckModeIpv6": { "type": "integer" }, "diconX": { "type": "integer" }, "diconY": { "type": "integer" }, "dcpuProtectionPolicyPointer": { "type": "string" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "encapType": { "type": "integer" }, "administrativeState": { "type": "integer" }, "portPointer": { "type": "string" }, "innerEncapValue": { "type": "integer" }, "outerEncapValue": { "type": "integer" }, "reassembly": { "type": "boolean", "default": false }, "dIconX": { "type": "integer" }, "dIconY": { "type": "integer" }, "ingressPolicyObjectPointer": { "type": "string" }, "egressPolicyObjectPointer": { "type": "string" }, "aggregation": { "type": "integer" }, "ingressSchedulerObjectPointer": { "type": "string" }, "egressSchedulerObjectPointer": { "type": "string" }, "aggregationSchedulerObjectPointer": { "type": "string" }, "ingressFilterPointer": { "type": "string" }, "ingressMatchQinqDot1pBits": { "type": "integer" }, "egressQinqMarkTopBitsOnly": { "type": "boolean", "default": false }, "egressFilterPointer": { "type": "string" }, "ingressIpv6FilterPointer": { "type": "string" }, "egressIpv6FilterPointer": { "type": "string" }, "accountingPolicyObjectPointer": { "type": "string" }, "accountingOn": { "type": "boolean", "default": false }, "ingressPolicerAccountingOn": { "type": "boolean", "default": false }, "egressQueueAccountingOn": { "type": "boolean", "default": false }, "sharedQueueOn": { "type": "boolean", "default": false }, "hsmdaEgrSecondaryShaper": { "type": "string" }, "hsmdaEgrQosPackByteOffOvrd": { "type": "integer" }, "egressAggRateLimit": { "type": "integer" }, "ingressAggRateLimit": { "type": "integer" }, "egressAggCIR": { "type": "integer" }, "ingressAggCIR": { "type": "integer" }, "egressSchedulerMode": { "type": "integer" }, "ingressSchedulerMode": { "type": "integer" }, "egressFrameBaseAccounting": { "type": "boolean", "default": false }, "dosProtection": { "type": "string" }, "dCpuProtectionPolicyPointer": { "type": "string" }, "ingressPolicerPolicyPointer": { "type": "string" }, "egressPolicerPolicyPointer": { "type": "string" }, "sapEgressStatsPktsMode": { "type": "boolean", "default": false }, "sapIngressCounterMode": { "type": "integer" }, "sapIngressCounterType": { "type": "integer" }, "sapEgressStatsEnable": { "type": "boolean", "default": false }, "sapIngressStatsEnable": { "type": "boolean", "default": false }, "transitIpPolicyPointer": { "type": "string" }, "transitPrefixPolicyPointer": { "type": "string" }, "hsmdaEgrQosWrrPlcyOvrd": { "type": "string" }, "ingressQueueGroupName": { "type": "string" }, "ingressRedirectListQueueGroup": { "type": "string" }, "egressRedirectListQueueGroup": { "type": "string" }, "ingressInstanceId": { "type": "integer" }, "egressPortQueueGroupPointer": { "type": "string" }, "egressPortQueueGroupName": { "type": "string" }, "egressPortQueueInstanceId": { "type": "integer" }, "aarpPointer": { "type": "string" }, "aarpServRefType": { "type": "integer" }, "egressAggRateLUB": { "type": "boolean", "default": false }, "egressAggRateLimitEnabled": { "type": "boolean", "default": false }, "egressAggRateLimitCIR": { "type": "integer" }, "egressAggRateLimitPIR": { "type": "integer" }, "macLearnOptions": { "type": "integer" }, "egressShaperGrpPointer": { "type": "string" }, "ingressShaperGrpPointer": { "type": "string" }, "sapIngressAggregateShaperRate": { "type": "integer" }, "sapEgressAggregateShaperRate": { "type": "integer" }, "hsEgrSecondaryShaper": { "type": "string" }, "egressRemarkingPolicyObjectPointer": { "type": "string" }, "egressRemarkPolicyObjectPointer": { "type": "string" }, "egressVlanQosPolicyObjectPointer": { "type": "string" }, "mprvlanId": { "type": "integer" }, "pmonPolicy": { "type": "string" }, "lockOlcState": { "type": "boolean", "default": false }, "templateVersionPointer": { "type": "string" }, "id": { "type": "integer" }, "sapIngressAggregateShaperRateCIR": { "type": "integer" }, "sapIngressAggregateShaperRatePIR": { "type": "integer" }, "physicalAddress": { "type": "string" }, "interfaceClass": { "type": "integer" }, "unnumberedReferenceType": { "type": "integer" }, "unnumberedReference": { "type": "string" }, "directedBroadcast": { "type": "boolean", "default": false }, "isTrusted": { "type": "integer" }, "loopbackEnabled": { "type": "boolean", "default": false }, "l3InterfaceDescription": { "type": "string" }, "l3InterfaceAdministrativeState": { "type": "integer" }, "shcvSource": { "type": "integer" }, "shcvAction": { "type": "integer" }, "shcvInterval": { "type": "integer" }, "shcvRetryTimeout": { "type": "integer" }, "shcvRetryCount": { "type": "integer" }, "usesMultipointShared": { "type": "integer" }, "todSuitePointer": { "type": "string" }, "unnumberedInterfaceName": { "type": "string" }, "unnumberedIpAddress": { "type": "string" }, "ipMtu": { "type": "integer" }, "localDhcpServerPointer": { "type": "string" }, "localDhcpServerName": { "type": "string" }, "aaApplicationProfile": { "type": "string" }, "callingStationId": { "type": "string" }, "uRPFCheckState": { "type": "integer" }, "uRPFCheckMode": { "type": "integer" }, "uRPFCheckStateIpv6": { "type": "integer" }, "uRPFCheckModeIpv6": { "type": "integer" }, "aaGrpId": { "type": "integer" }, "aaPartId": { "type": "integer" }, "l3dosProtection": { "type": "string" }, "macMonitoring": { "type": "boolean", "default": false }, "ipMonitoring": { "type": "boolean", "default": false }, "cpmProtEthCfmMonitorFlags": { "type": "integer" }, "vplsName": { "type": "string" }, "vplsEgressQosPolicyPointer": { "type": "string" }, "vplsIngressIPv4FilterPointer": { "type": "string" }, "vplsIngressIPv6FilterPointer": { "type": "string" }, "vplsEgressIPv4FilterPointer": { "type": "string" }, "vplsEgressIPv6FilterPointer": { "type": "string" }, "localDhcp6ServerPointer": { "type": "string" }, "monitorOperGroupName": { "type": "string" }, "monitorOperGroupPtr": { "type": "string" }, "qosRouteLookupIpv4": { "type": "integer" }, "qosRouteLookupIpv6": { "type": "integer" }, "sasIngressPolicyObjectPointer": { "type": "string" }, "sapIngressAggregateMeterRate": { "type": "integer" }, "sapIngressAggregateMeterBurst": { "type": "integer" }, "sapIngressWithAggregateMeter": { "type": "integer" }, "sapIngressAggregateMeterCIR": { "type": "integer" }, "sapIngressAggregateMeterCBS": { "type": "integer" }, "sapEgressAggregateMeterBurst": { "type": "integer" }, "sapEgressAggregateMeterEnableStats": { "type": "integer" }, "sapEgressAggregateMeterRate": { "type": "integer" }, "sasEgressPolicyObjectPointer": { "type": "string" }, "radiusProxyServerPointer": { "type": "string" }, "globalIfIndex": { "type": "integer" }, "hostLockoutPolicyPointer": { "type": "string" }, "enableIngressStats": { "type": "boolean", "default": false }, "lagLinkMapProfilePointer": { "type": "string" }, "ingressFlowspec": { "type": "boolean", "default": false }, "ingressIPv6Flowspec": { "type": "boolean", "default": false }, "staticTnlRedNHAddrType": { "type": "integer" }, "staticTnlRedNHAddr": { "type": "string" }, "dynamicTnlRedNHAddrType": { "type": "integer" }, "dynamicTnlRedNHAddr": { "type": "string" }, "enableMacAccountingStats": { "type": "boolean", "default": false }, "aluIfL4LoadBalancing": { "type": "integer" }, "ifTeIdLoadBalancing": { "type": "boolean", "default": false }, "egrIpLoadBalancing": { "type": "integer" }, "spiLoadBalancing": { "type": "boolean", "default": false }, "ipv6FlowLabelHashing": { "type": "boolean", "default": false }, "securityPolicyBypass": { "type": "boolean", "default": false }, "zonePointer": { "type": "string" }, "zoneId": { "type": "integer" }, "policyAccountingTemplatePointer": { "type": "string" }, "sharedRiskLinkGroupPointers": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "adminGroupInclude": { "type": "integer" }, "shcvPolicyIPv4Pointer": { "type": "string" }, "ipv6Allowed": { "type": "boolean", "default": false }, "vasIfType": { "type": "integer" }, "ipv6NeighborLimit": { "type": "integer" }, "ipv6NeighborLogOnly": { "type": "boolean", "default": false }, "ipv6NeighborThreshold": { "type": "integer" }, "bandwidth": { "type": "integer" }, "bandwidthHi": { "type": "integer" }, "ignoreSapPortState": { "type": "integer" }, "schedulerPolicyObjectPointer": { "type": "string" }, "arpLearnUnsolicited": { "type": "boolean", "default": false }, "arpPopulateHostRoute": { "type": "boolean", "default": false }, "arpRouteTag": { "type": "string" }, "neighbhorPopulateHostRoute": { "type": "boolean", "default": false }, "neighbhorRouteTag": { "type": "string" }, "arpProactiveRefresh": { "type": "boolean", "default": false }, "neighborLearnUnsolicited": { "type": "integer" }, "neighborProactiveRefresh": { "type": "integer" }, "enableTableClassification": { "type": "boolean", "default": false }, "enableTableClassificationForRvpls": { "type": "boolean", "default": false }, "routedOverrideQosPolicyPointer": { "type": "string" }, "forwardIPv4Packets": { "type": "boolean", "default": false }, "arpLearnDynamic": { "type": "boolean", "default": false }, "ndLearnDynamic": { "type": "boolean", "default": false }, "floodGarpAndUnknownReq": { "type": "boolean", "default": false }, "ipCriteriaOverrideTag": { "type": "integer" }, "ipv6CriteriaOverrideTag": { "type": "integer" }, "ingrDestinationClassLookup": { "type": "boolean", "default": false }, "overrides": { "type": "object", "additionalProperties": { "type": "string" } } }, "description": "Model containing the method level model for Interface ConfigInfo L3AccessInterfaceConfigInfo. to decode json data to internal NFM-P object model" }, "secondObject": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "pmtuDiscoveryAging": { "type": "integer" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "serviceIdPointer": { "type": "string" }, "adminState": { "type": "integer" }, "certTrustAnchorPointer": { "type": "string" }, "gwAddressType": { "type": "integer" }, "gwIpAddress": { "type": "string" }, "ikePolicyPointer": { "type": "string" }, "preSharedKey": { "type": "string" }, "certFile": { "type": "string" }, "keyFile": { "type": "string" }, "certProfilePointer": { "type": "string" }, "trustAnchorProfilePointer": { "type": "string" }, "defaultResult": { "type": "integer" }, "primary": { "type": "integer" }, "secondary": { "type": "integer" }, "localIdType": { "type": "integer" }, "localIdValue": { "type": "string" }, "description": { "type": "string" }, "dynamicKeyTransformId1Pointer": { "type": "string" }, "dynamicKeyTransformId2Pointer": { "type": "string" }, "dynamicKeyTransformId3Pointer": { "type": "string" }, "dynamicKeyTransformId4Pointer": { "type": "string" }, "replayWindow": { "type": "integer" }, "tunnelName": { "type": "string" }, "remoteAddressType": { "type": "integer" }, "remoteIpAddress": { "type": "string" }, "securityPolicyPointer": { "type": "string" }, "keying": { "type": "integer" }, "autoEstablish": { "type": "boolean", "default": false }, "bfdDesignate": { "type": "boolean", "default": false }, "bfdEnable": { "type": "boolean", "default": false }, "ipMtu": { "type": "integer" }, "encapsulatedIpMtu": { "type": "integer" }, "clearDfBit": { "type": "boolean", "default": false }, "copyDfBit": { "type": "boolean", "default": false }, "icmp6Pkt2Big": { "type": "boolean", "default": false }, "icmp6NumPkt2Big": { "type": "integer" }, "icmp6Pkt2BigTime": { "type": "integer" }, "publicTcpMssAdjust": { "type": "integer" }, "privateTcpMssAdjust": { "type": "integer" }, "secPlcyStrictMatch": { "type": "boolean", "default": false }, "propogatePMtuV4": { "type": "boolean", "default": false }, "propogatePMtuV6": { "type": "boolean", "default": false }, "icmpFragReq": { "type": "boolean", "default": false }, "icmpFragReqNum": { "type": "integer" }, "icmpFragReqTime": { "type": "integer" }, "pMtuDiscoveryAging": { "type": "integer" }, "copyTrafficClass": { "type": "boolean", "default": false }, "creationOrigin": { "type": "integer" } }, "description": "Model containing the method level model for Interface ConfigInfo IPSecTunnelConfigInfo. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for struct Pair. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for IPSecSecuredVpnManager.configureIPSecSecuredVPN to decode json data to internal NFM-P object model" } } ], "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": "/restIpsecIPSecSecuredVpnManagerConfigureIPSecSecuredVPN" }, "task": true }, { "name": "restIpsecInternalDHCPv4AddressAssignmentShutDown", "summary": "rest_ipsec_InternalDHCPv4AddressAssignment_shutDown", "description": "rest_ipsec_InternalDHCPv4AddressAssignment_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restIpsecInternalDHCPv4AddressAssignmentShutDown" }, "task": true }, { "name": "restIpsecInternalDHCPv4AddressAssignmentTurnUp", "summary": "rest_ipsec_InternalDHCPv4AddressAssignment_turnUp", "description": "rest_ipsec_InternalDHCPv4AddressAssignment_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restIpsecInternalDHCPv4AddressAssignmentTurnUp" }, "task": true }, { "name": "restIpsecInternalDHCPv6AddressAssignmentShutDown", "summary": "rest_ipsec_InternalDHCPv6AddressAssignment_shutDown", "description": "rest_ipsec_InternalDHCPv6AddressAssignment_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restIpsecInternalDHCPv6AddressAssignmentShutDown" }, "task": true }, { "name": "restIpsecInternalDHCPv6AddressAssignmentTurnUp", "summary": "rest_ipsec_InternalDHCPv6AddressAssignment_turnUp", "description": "rest_ipsec_InternalDHCPv6AddressAssignment_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restIpsecInternalDHCPv6AddressAssignmentTurnUp" }, "task": true }, { "name": "restIpsecLocalAddressAssignmentShutDown", "summary": "rest_ipsec_LocalAddressAssignment_shutDown", "description": "rest_ipsec_LocalAddressAssignment_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restIpsecLocalAddressAssignmentShutDown" }, "task": true }, { "name": "restIpsecLocalAddressAssignmentTurnUp", "summary": "rest_ipsec_LocalAddressAssignment_turnUp", "description": "rest_ipsec_LocalAddressAssignment_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restIpsecLocalAddressAssignmentTurnUp" }, "task": true }, { "name": "restIsaAaEsmHostInfoRetrieveAaEsmHosts", "summary": "retrieveAaEsmHosts", "description": "Method to query the NE for AaEsmHost. Intention : RETRIEVER retrieveAaEsmHosts: class-level retriever API retrieveAaEsmHosts of class isa.AaEsmHostInfo", "input": [ { "name": "body", "type": "object", "info": ": {\"aInHostInfoRtrvStruct\": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"serviceId\": 123, \"portName\": \"string\", \"innerEncap\": 123, \"outerEncap\": 123}, \"aInTimeout\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInHostInfoRtrvStruct": { "type": "object", "required": [ "innerEncap", "objectClassName", "outerEncap", "portName", "serviceId", "siteId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "serviceId": { "type": "integer" }, "portName": { "type": "string" }, "innerEncap": { "type": "integer" }, "outerEncap": { "type": "integer" } }, "description": "Model containing the method level model for struct AaEsmHostRtrvStruct. to decode json data to internal NFM-P object model" }, "aInTimeout": { "type": "integer" } }, "description": "Model containing the method level model for AaEsmHostInfo.retrieveAaEsmHosts to decode json data to internal NFM-P object model" } } ], "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": "/restIsaAaEsmHostInfoRetrieveAaEsmHosts" }, "task": true }, { "name": "restIsaAaGroupGetDependencyCount", "summary": "getDependencyCount", "description": "Count the total number of AA subscriber, SAPs, and spoke SDP binding summary information objects on the group. Intention : RETRIEVER getDependencyCount: instance-level retriever API getDependencyCount of class isa.AaGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restIsaAaGroupGetDependencyCount" }, "task": true }, { "name": "restIsaAaSapInfoInvokeResyncAaSapInfo", "summary": "rest_isa_AaSapInfo_invokeResyncAaSapInfo", "description": "rest_isa_AaSapInfo_invokeResyncAaSapInfo", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"isaGrpPartIndex\": 123}", "required": false, "schema": { "type": "object", "required": [ "isaGrpPartIndex", "siteId" ], "properties": { "siteId": { "type": "string", "description": " Network Element site IP address." }, "isaGrpPartIndex": { "type": "integer", "description": " The ISA-AA Group Partition Index." } }, "description": "Model containing the method level model for AaSapInfo.invokeResyncAaSapInfo to decode json data to internal NFM-P object model" } } ], "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": "/restIsaAaSapInfoInvokeResyncAaSapInfo" }, "task": true }, { "name": "restIsaAaSpokeSdpBindingInfoInvokeResyncAaSpokeSdpBindingInfo", "summary": "rest_isa_AaSpokeSdpBindingInfo_invokeResyncAaSpokeSdpBindingInfo", "description": "rest_isa_AaSpokeSdpBindingInfo_invokeResyncAaSpokeSdpBindingInfo", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"isaGrpPartIndex\": 123}", "required": false, "schema": { "type": "object", "required": [ "isaGrpPartIndex", "siteId" ], "properties": { "siteId": { "type": "string", "description": " Network Element site IP address." }, "isaGrpPartIndex": { "type": "integer", "description": " The ISA-AA Group Partition Index." } }, "description": "Model containing the method level model for AaSpokeSdpBindingInfo.invokeResyncAaSpokeSdpBindingInfo to decode json data to internal NFM-P object model" } } ], "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": "/restIsaAaSpokeSdpBindingInfoInvokeResyncAaSpokeSdpBindingInfo" }, "task": true }, { "name": "restIsaAaSubInfoInvokeResyncAaSubInfo", "summary": "rest_isa_AaSubInfo_invokeResyncAaSubInfo", "description": "rest_isa_AaSubInfo_invokeResyncAaSubInfo", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"isaGrpPartIndex\": 123}", "required": false, "schema": { "type": "object", "required": [ "isaGrpPartIndex", "siteId" ], "properties": { "siteId": { "type": "string", "description": " Network Element site IP address." }, "isaGrpPartIndex": { "type": "integer", "description": " The ISA-AA Group Partition Index." } }, "description": "Model containing the method level model for AaSubInfo.invokeResyncAaSubInfo to decode json data to internal NFM-P object model" } } ], "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": "/restIsaAaSubInfoInvokeResyncAaSubInfo" }, "task": true }, { "name": "restIsaIPSecIsaGroupGetDependencyCount", "summary": "getDependencyCount", "description": "Intention : RETRIEVER getDependencyCount: instance-level retriever API getDependencyCount of class isa.IPSecIsaGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restIsaIPSecIsaGroupGetDependencyCount" }, "task": true }, { "name": "restIsaLnsGroupGetDependencyCount", "summary": "getDependencyCount", "description": "Intention : RETRIEVER getDependencyCount: instance-level retriever API getDependencyCount of class isa.LnsGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restIsaLnsGroupGetDependencyCount" }, "task": true }, { "name": "restIsaVideoGroupGetDependencyCount", "summary": "getDependencyCount", "description": "Intention : RETRIEVER getDependencyCount: instance-level retriever API getDependencyCount of class isa.VideoGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restIsaVideoGroupGetDependencyCount" }, "task": true }, { "name": "restIsisAreaConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class isis.Area This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"areaId\": \"string\", \"areaName\": \"string\", \"areaDescription\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "areaId": { "type": "string" }, "areaName": { "type": "string" }, "areaDescription": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo AreaConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restIsisAreaConfigure" }, "task": true }, { "name": "restIsisAuthenticationKeyRemoveAuthenticationKey", "summary": "rest_isis_AuthenticationKey_removeAuthenticationKey", "description": "rest_isis_AuthenticationKey_removeAuthenticationKey", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restIsisAuthenticationKeyRemoveAuthenticationKey" }, "task": true }, { "name": "restIsisInterfaceConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class isis.Interface This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restIsisInterfaceConfigure" }, "task": true }, { "name": "restIsisIsisConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure on default instance isis of class isis.Isis This API follows hierarchical config model rules.", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restIsisIsisConfigure" }, "task": true }, { "name": "restIsisSiteExportPolicyConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class isis.SiteExportPolicy This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restIsisSiteExportPolicyConfigure" }, "task": true }, { "name": "restL2fibFibEntryClearFib", "summary": "rest_l2fib_FibEntry_clearFib", "description": "rest_l2fib_FibEntry_clearFib", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restL2fibFibEntryClearFib" }, "task": true }, { "name": "restL2fibFibEntryDefineFibEntries", "summary": "rest_l2fib_FibEntry_defineFibEntries", "description": "rest_l2fib_FibEntry_defineFibEntries", "input": [ { "name": "body", "type": "object", "info": ": {\"configs\": [{\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\"}], \"removeFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"shouldComplete\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "configs", "removeFilter", "shouldComplete" ], "properties": { "configs": { "type": "array", "description": " ", "items": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "removeFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "shouldComplete": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for FibEntry.defineFibEntries to decode json data to internal NFM-P object model" } } ], "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": "/restL2fibFibEntryDefineFibEntries" }, "task": true }, { "name": "restL2fibFibEntryDefineFibEntry", "summary": "rest_l2fib_FibEntry_defineFibEntry", "description": "rest_l2fib_FibEntry_defineFibEntry", "input": [ { "name": "body", "type": "object", "info": ": {\"macAddress\": \"string\", \"terminatedObject\": \"string\", \"shouldComplete\": \"boolean\", \"type\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "macAddress", "shouldComplete", "terminatedObject", "type" ], "properties": { "macAddress": { "type": "string", "description": " " }, "terminatedObject": { "type": "string", "description": " " }, "shouldComplete": { "type": "boolean", "description": " ", "default": false }, "type": { "type": "string", "description": " " } }, "description": "Model containing the method level model for FibEntry.defineFibEntry to decode json data to internal NFM-P object model" } } ], "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": "/restL2fibFibEntryDefineFibEntry" }, "task": true }, { "name": "restL2fibFibEntryForceAutocomplete", "summary": "rest_l2fib_FibEntry_forceAutocomplete", "description": "rest_l2fib_FibEntry_forceAutocomplete", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restL2fibFibEntryForceAutocomplete" }, "task": true }, { "name": "restL2fibFibEntryMakeEntryFibStatic", "summary": "rest_l2fib_FibEntry_makeEntryFibStatic", "description": "rest_l2fib_FibEntry_makeEntryFibStatic", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restL2fibFibEntryMakeEntryFibStatic" }, "task": true }, { "name": "restL2fibFibEntryMakeFibStatic", "summary": "rest_l2fib_FibEntry_makeFibStatic", "description": "rest_l2fib_FibEntry_makeFibStatic", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restL2fibFibEntryMakeFibStatic" }, "task": true }, { "name": "restL2fibFibEntryRemoveFibEntry", "summary": "rest_l2fib_FibEntry_removeFibEntry", "description": "rest_l2fib_FibEntry_removeFibEntry", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restL2fibFibEntryRemoveFibEntry" }, "task": true }, { "name": "restL2fibFibEntryResync", "summary": "rest_l2fib_FibEntry_resync", "description": "rest_l2fib_FibEntry_resync", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restL2fibFibEntryResync" }, "task": true }, { "name": "restL2fibMFibEntryGetDefinedObject", "summary": "getDefinedObject", "description": "Retrieves the access interface or circuit on which the mfib entry is defined. Intention : RETRIEVER getDefinedObject: instance-level retriever API getDefinedObject of class l2fib.MFibEntry instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restL2fibMFibEntryGetDefinedObject" }, "task": true }, { "name": "restL2fibMFibEntryResync", "summary": "rest_l2fib_MFibEntry_resync", "description": "rest_l2fib_MFibEntry_resync", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restL2fibMFibEntryResync" }, "task": true }, { "name": "restL2fwdAbstractMmrpEntryResync", "summary": "rest_l2fwd_AbstractMmrpEntry_resync", "description": "rest_l2fwd_AbstractMmrpEntry_resync", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restL2fwdAbstractMmrpEntryResync" }, "task": true }, { "name": "restL2fwdMldSiteMvrFindUserMvrSaps", "summary": "findUserMvrSaps", "description": "Intention : RETRIEVER findUserMvrSaps: class-level [object finder] (retriever) API findUserMvrSaps of class l2fwd.MldSiteMvr List of SAPS which are using these MVR VPLS Service(s).", "input": [ { "name": "body", "type": "object", "info": ": {\"vplsServiceId\": 123, \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter", "vplsServiceId" ], "properties": { "vplsServiceId": { "type": "integer", "description": " " }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for MldSiteMvr.findUserMvrSaps to decode json data to internal NFM-P object model" } } ], "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": "/restL2fwdMldSiteMvrFindUserMvrSaps" }, "task": true }, { "name": "restL2fwdMrpPolicyEntryRenum", "summary": "rest_l2fwd_MrpPolicyEntry_renum", "description": "rest_l2fwd_MrpPolicyEntry_renum", "input": [ { "name": "body", "type": "object", "info": ": {\"aInNewEntryFullName\": \"string\", \"aInOldEntryFullName\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInNewEntryFullName": { "type": "string" }, "aInOldEntryFullName": { "type": "string" } }, "description": "Model containing the method level model for SecurityPolicyEntryDefinition.renum to decode json data to internal NFM-P object model" } } ], "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": "/restL2fwdMrpPolicyEntryRenum" }, "task": true }, { "name": "restL2fwdSiteMvrFindUserMvrSaps", "summary": "findUserMvrSaps", "description": "Intention : RETRIEVER findUserMvrSaps: class-level [object finder] (retriever) API findUserMvrSaps of class l2fwd.SiteMvr List of SAPS which are using these MVR VPLS Service(s).", "input": [ { "name": "body", "type": "object", "info": ": {\"vplsServiceId\": 123, \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter", "vplsServiceId" ], "properties": { "vplsServiceId": { "type": "integer", "description": " " }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for MldSiteMvr.findUserMvrSaps to decode json data to internal NFM-P object model" } } ], "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": "/restL2fwdSiteMvrFindUserMvrSaps" }, "task": true }, { "name": "restL2tpGroupProfileRemovePassword", "summary": "rest_l2tp_GroupProfile_removePassword", "description": "rest_l2tp_GroupProfile_removePassword", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restL2tpGroupProfileRemovePassword" }, "task": true }, { "name": "restL2tpGroupProfileRetrieveEthernetSessions", "summary": "retrieveEthernetSessions", "description": "Method used to retrieve Ethernet Tunnel session(s) from NE. Intention : RETRIEVER retrieveEthernetSessions: class-level retriever API retrieveEthernetSessions of class l2tp.GroupProfile", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"routerId\": 123, \"groupName\": \"string\", \"vcId\": 123, \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "filter", "groupName", "objectClassName", "routerId", "siteId", "timeout", "vcId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "routerId": { "type": "integer" }, "groupName": { "type": "string" }, "vcId": { "type": "integer" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct L2TPEthernetSessionStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restL2tpGroupProfileRetrieveEthernetSessions" }, "task": true }, { "name": "restL2tpGroupProfileStopTunnels", "summary": "rest_l2tp_GroupProfile_stopTunnels", "description": "rest_l2tp_GroupProfile_stopTunnels", "input": [ { "name": "body", "type": "object", "info": ": {\"aInGroupNameList\": \"array\", \"aInSiteId\": \"string\", \"aInRouterId\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInGroupNameList": { "type": "array", "items": { "type": "string" } }, "aInSiteId": { "type": "string" }, "aInRouterId": { "type": "integer" } }, "description": "Model containing the method level model for GroupProfile.stopTunnels to decode json data to internal NFM-P object model" } } ], "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": "/restL2tpGroupProfileStopTunnels" }, "task": true }, { "name": "restL2tpL2TPSessionRetrieveL2TPSessions", "summary": "retrieveL2TPSessions", "description": "Method used to retrieve L2TP session(s) from NE. Intention : RETRIEVER retrieveL2TPSessions: class-level retriever API retrieveL2TPSessions of class l2tp.L2TPSession", "input": [ { "name": "body", "type": "object", "info": ": {\"sessionStruct\": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"routerId\": 123, \"connectionId\": 123, \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"timeout\": 123}, \"shallowRetrieval\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "sessionStruct", "shallowRetrieval" ], "properties": { "sessionStruct": { "type": "object", "required": [ "connectionId", "filter", "objectClassName", "routerId", "siteId", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "routerId": { "type": "integer" }, "connectionId": { "type": "integer" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct SessionStruct. to decode json data to internal NFM-P object model" }, "shallowRetrieval": { "type": "boolean", "description": " If it is true, not all of the properties are retrieved for quick response default:false", "default": false } }, "description": "Model containing the method level model for L2TPSession.retrieveL2TPSessions to decode json data to internal NFM-P object model" } } ], "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": "/restL2tpL2TPSessionRetrieveL2TPSessions" }, "task": true }, { "name": "restL2tpL2TPSessionRetrieveL2TPv3EthernetTunnelStats", "summary": "retrieveL2TPv3EthernetTunnelStats", "description": "Method used to retrieve L2TPv3 Ethernet session stats from NE. Intention : RETRIEVER retrieveL2TPv3EthernetTunnelStats: class-level retriever API retrieveL2TPv3EthernetTunnelStats of class l2tp.L2TPSession", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"routerId\": 123, \"connectionId\": 123, \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "connectionId", "filter", "objectClassName", "routerId", "siteId", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "routerId": { "type": "integer" }, "connectionId": { "type": "integer" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct SessionStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restL2tpL2TPSessionRetrieveL2TPv3EthernetTunnelStats" }, "task": true }, { "name": "restL2tpL2TPv3TunnelGroupConfigRemovePassword", "summary": "rest_l2tp_L2TPv3TunnelGroupConfig_removePassword", "description": "rest_l2tp_L2TPv3TunnelGroupConfig_removePassword", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restL2tpL2TPv3TunnelGroupConfigRemovePassword" }, "task": true }, { "name": "restL2tpL2TPv3VirtualRouterConfigRemovePassword", "summary": "rest_l2tp_L2TPv3VirtualRouterConfig_removePassword", "description": "rest_l2tp_L2TPv3VirtualRouterConfig_removePassword", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restL2tpL2TPv3VirtualRouterConfigRemovePassword" }, "task": true }, { "name": "restL2tpLacMlpppBundleRetrieveLacMlpppBundles", "summary": "retrieveLacMlpppBundles", "description": "Method used to retrieve Retrieving Lac MLPPP Bundle(s) from NE. Intention : RETRIEVER retrieveLacMlpppBundles: class-level retriever API retrieveLacMlpppBundles of class l2tp.LacMlpppBundle", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"routerId\": 123, \"bundleId\": 123, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "bundleId", "objectClassName", "routerId", "siteId", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "routerId": { "type": "integer" }, "bundleId": { "type": "integer" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct RetrievingLacMlpppBundleStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restL2tpLacMlpppBundleRetrieveLacMlpppBundles" }, "task": true }, { "name": "restL2tpSiteRemovePassword", "summary": "rest_l2tp_Site_removePassword", "description": "rest_l2tp_Site_removePassword", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restL2tpSiteRemovePassword" }, "task": true }, { "name": "restL2tpTunnelProfileDrain", "summary": "rest_l2tp_TunnelProfile_drain", "description": "rest_l2tp_TunnelProfile_drain", "input": [ { "name": "body", "type": "object", "info": ": {\"aInGroupName\": \"string\", \"aInTunnelNameList\": \"array\", \"aInAction\": 123, \"aInSiteId\": \"string\", \"aInRouterId\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInGroupName": { "type": "string" }, "aInTunnelNameList": { "type": "array", "items": { "type": "string" } }, "aInAction": { "type": "integer" }, "aInSiteId": { "type": "string" }, "aInRouterId": { "type": "integer" } }, "description": "Model containing the method level model for TunnelProfile.drain to decode json data to internal NFM-P object model" } } ], "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": "/restL2tpTunnelProfileDrain" }, "task": true }, { "name": "restL2tpTunnelProfileRemovePassword", "summary": "rest_l2tp_TunnelProfile_removePassword", "description": "rest_l2tp_TunnelProfile_removePassword", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restL2tpTunnelProfileRemovePassword" }, "task": true }, { "name": "restL2tpTunnelProfileStopTunnels", "summary": "rest_l2tp_TunnelProfile_stopTunnels", "description": "rest_l2tp_TunnelProfile_stopTunnels", "input": [ { "name": "body", "type": "object", "info": ": {\"aInGroupNameList\": \"array\", \"aInSiteId\": \"string\", \"aInRouterId\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInGroupNameList": { "type": "array", "items": { "type": "string" } }, "aInSiteId": { "type": "string" }, "aInRouterId": { "type": "integer" } }, "description": "Model containing the method level model for GroupProfile.stopTunnels to decode json data to internal NFM-P object model" } } ], "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": "/restL2tpTunnelProfileStopTunnels" }, "task": true }, { "name": "restL3fwdServiceSiteGenerateNewRouteDistinguisher", "summary": "generateNewRouteDistinguisher", "description": "Generates a new globally unique Route Distinguisher. Intention : MODIFIER generateNewRouteDistinguisher: class-level modifier API generateNewRouteDistinguisher of class l3fwd.ServiceSite Returns the generated Route Distinguisher. The format of Route Distinguisher is: \"value1:value2\".", "input": [ { "name": "body", "type": "object", "info": ": {\"neId\": \"string\", \"routeDistinguisherType\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "neId", "routeDistinguisherType" ], "properties": { "neId": { "type": "string", "description": " The Network Element ID. This value must be a valid NE ID and cannot be null nor empty." }, "routeDistinguisherType": { "type": "string", "description": " At this time only type0(0) is supported." } }, "description": "Model containing the method level model for ServiceSite.generateNewRouteDistinguisher to decode json data to internal NFM-P object model" } } ], "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": "/restL3fwdServiceSiteGenerateNewRouteDistinguisher" }, "task": true }, { "name": "restL3fwdServiceSiteGenerateNewVrfTarget", "summary": "generateNewVrfTarget", "description": "Generates a new globally unique VRF target. Intention : MODIFIER generateNewVrfTarget: class-level modifier API generateNewVrfTarget of class l3fwd.ServiceSite Returns the generated VRF Target. The format of VRF Target is: \"value1:value2\".", "input": [ { "name": "body", "type": "object", "info": ": {\"neId\": \"string\", \"vrfTargetFormat\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "neId", "vrfTargetFormat" ], "properties": { "neId": { "type": "string", "description": " The Network Element ID. This value must be a valid NE ID and cannot be null nor empty." }, "vrfTargetFormat": { "type": "string", "description": " The VRF Target Format, asBased (2) or ipAddressBased(3).At this time only asBased(2) is supported." } }, "description": "Model containing the method level model for ServiceSite.generateNewVrfTarget to decode json data to internal NFM-P object model" } } ], "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": "/restL3fwdServiceSiteGenerateNewVrfTarget" }, "task": true }, { "name": "restL3fwdServiceSiteGetRouteDistinguisherValues", "summary": "getRouteDistinguisherValues", "description": "Retrieves the set of Route Distinguisher used by a specific VPRN service. Intention : RETRIEVER getRouteDistinguisherValues: class-level retriever API getRouteDistinguisherValues of class l3fwd.ServiceSite Returns the set of Route Distinguishers used by this VPRN service. The format of each Route Distinguisher entry is: \"value1:value2\".", "input": [ { "name": "servicePointer", "type": "string", "info": ": string", "required": false, "schema": { "title": "servicePointer", "type": "string" } }, { "name": "routeDistinguisherType", "type": "string", "info": ": string", "required": false, "schema": { "title": "routeDistinguisherType", "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": "/restL3fwdServiceSiteGetRouteDistinguisherValues" }, "task": true }, { "name": "restL3fwdServiceSiteGetVrfTargets", "summary": "getVrfTargets", "description": "Retrieves the set of VRF targets used by a specific VPRN service. Intention : RETRIEVER getVrfTargets: class-level retriever API getVrfTargets of class l3fwd.ServiceSite Returns the set of VRF Targets used by this VPRN service. The format of each VRF Target entry is: \"value1:value2\".", "input": [ { "name": "servicePointer", "type": "string", "info": ": string", "required": false, "schema": { "title": "servicePointer", "type": "string" } }, { "name": "vrfTargetFormat", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrfTargetFormat", "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": "/restL3fwdServiceSiteGetVrfTargets" }, "task": true }, { "name": "restLagInterfaceRequestClearSubVlanStats", "summary": "requestClearSubVlanStats", "description": "Request clearing of Subscriber VLAN statistics. Statistics will be for all service access points with the corresponding lag id and outer encap value. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearSubVlanStats: class-level modifier API requestClearSubVlanStats of class lag.Interface A request handle which allows the retrieval of the request (and its resul...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"portName\": \"string\", \"vlanId\": 123}", "required": false, "schema": { "type": "object", "required": [ "portName", "siteId", "vlanId" ], "properties": { "siteId": { "type": "string", "description": " Specifies Site ID of the Subscriber VLAN Statistics to be cleared.This is mandatory parameter." }, "portName": { "type": "string", "description": " Specifies port of the Subscriber VLAN Statistics to be cleared.This is mandatory parameter." }, "vlanId": { "type": "integer", "description": " Specifies VLAN ID the Subscriber VLAN Statistics to be cleared.This value is equal to the outer encapsulation value on the Service Access Point.If set to -1, all Subscriber VLAN Statistics on the specified port will be cleared. default:-1" } }, "description": "Model containing the method level model for PwPort.requestClearSubVlanStats to decode json data to internal NFM-P object model" } } ], "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": "/restLagInterfaceRequestClearSubVlanStats" }, "task": true }, { "name": "restLagSiteFindLags", "summary": "findLags", "description": "Intention : RETRIEVER findLags: instance-level [object finder] (retriever) API findLags of class lag.Site instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restLagSiteFindLags" }, "task": true }, { "name": "restLayer2BridgeConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class layer2.Bridge This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restLayer2BridgeConfigure" }, "task": true }, { "name": "restLayer2MvrInterfaceConfigureConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class layer2.MvrInterfaceConfigure This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restLayer2MvrInterfaceConfigureConfigure" }, "task": true }, { "name": "restLayer2MvrSiteConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class layer2.MvrSite This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restLayer2MvrSiteConfigure" }, "task": true }, { "name": "restLayer2NetworkInterfaceConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class layer2.NetworkInterface This API follows hierarchical config model rules. DescendantInfo: vlan.NetworkInterface instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restLayer2NetworkInterfaceConfigure" }, "task": true }, { "name": "restLayer2SuperVlanInterfaceConfigureConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class layer2.SuperVlanInterfaceConfigure This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restLayer2SuperVlanInterfaceConfigureConfigure" }, "task": true }, { "name": "restLayer2TlsInterfaceConfigureConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class layer2.TlsInterfaceConfigure This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restLayer2TlsInterfaceConfigureConfigure" }, "task": true }, { "name": "restLayer2TlsSiteConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class layer2.TlsSite This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restLayer2TlsSiteConfigure" }, "task": true }, { "name": "restLdpAccountingFecPrefixShutDown", "summary": "rest_ldp_AccountingFecPrefix_shutDown", "description": "rest_ldp_AccountingFecPrefix_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restLdpAccountingFecPrefixShutDown" }, "task": true }, { "name": "restLdpAccountingFecPrefixTurnUp", "summary": "rest_ldp_AccountingFecPrefix_turnUp", "description": "rest_ldp_AccountingFecPrefix_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restLdpAccountingFecPrefixTurnUp" }, "task": true }, { "name": "restLdpAuthenticationKeyRemoveAuthenticationKey", "summary": "rest_ldp_AuthenticationKey_removeAuthenticationKey", "description": "rest_ldp_AuthenticationKey_removeAuthenticationKey", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restLdpAuthenticationKeyRemoveAuthenticationKey" }, "task": true }, { "name": "restLdpInterfaceConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class ldp.Interface This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restLdpInterfaceConfigure" }, "task": true }, { "name": "restLdpSiteConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class ldp.Site This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restLdpSiteConfigure" }, "task": true }, { "name": "restLmgperfLMGPMPolicyFindLmgNodes", "summary": "findLmgNodes", "description": "Find all managed eNodeBs for the specified Performance Management polling policy assigned. Intention : RETRIEVER findLmgNodes: class-level [object finder] (retriever) API findLmgNodes of class lmgperf.LMGPMPolicy DescendantInfo: lmgperf.LMGNodePMPolicy", "input": [ { "name": "policyId", "type": "number", "info": ": 123", "required": false, "schema": { "title": "policyId", "type": "number" } } ], "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": "/restLmgperfLMGPMPolicyFindLmgNodes" }, "task": true }, { "name": "restLmgperfLMGPMPolicyInvokeCatchup", "summary": "rest_lmgperf_LMGPMPolicy_invokeCatchup", "description": "rest_lmgperf_LMGPMPolicy_invokeCatchup", "input": [ { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restLmgperfLMGPMPolicyInvokeCatchup" }, "task": true }, { "name": "restLmgperfLMGPMPolicyInvokeLMGsCatchup", "summary": "rest_lmgperf_LMGPMPolicy_invokeLMGsCatchup", "description": "rest_lmgperf_LMGPMPolicy_invokeLMGsCatchup", "input": [ { "name": "body", "type": "object", "info": ": {\"networkElements\": \"array\", \"forceOnPMPolicyDown\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "forceOnPMPolicyDown", "networkElements" ], "properties": { "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "forceOnPMPolicyDown": { "type": "boolean", "description": " default:false", "default": false } }, "description": "Model containing the method level model for LMGPMPolicy.invokeLMGsCatchup to decode json data to internal NFM-P object model" } } ], "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": "/restLmgperfLMGPMPolicyInvokeLMGsCatchup" }, "task": true }, { "name": "restLocaluserdbLocalUserDbRetrieveLocalUserDatabases", "summary": "retrieveLocalUserDatabases", "description": "This method gets the local user database entries from the database. Intention : RETRIEVER retrieveLocalUserDatabases: class-level retriever API retrieveLocalUserDatabases of class localuserdb.LocalUserDb The number of local user databases.", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restLocaluserdbLocalUserDbRetrieveLocalUserDatabases" }, "task": true }, { "name": "restLogLogPolicyPurge", "summary": "rest_log_LogPolicy_purge", "description": "rest_log_LogPolicy_purge", "input": [ { "name": "body", "type": "object", "info": ": {\"logEntityType\": \"string\", \"className\": \"string\", \"purgeType\": \"string\", \"recordFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "className", "logEntityType", "purgeType", "recordFilter" ], "properties": { "logEntityType": { "type": "string", "description": " Type of record to be purged." }, "className": { "type": "string", "description": " Class name of the records to be purged." }, "purgeType": { "type": "string", "description": " Not used." }, "recordFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for LogPolicy.purge to decode json data to internal NFM-P object model" } } ], "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": "/restLogLogPolicyPurge" }, "task": true }, { "name": "restLpsLPSConfigurationRestartLearningWindowTimer", "summary": "rest_lps_LPSConfiguration_restartLearningWindowTimer", "description": "rest_lps_LPSConfiguration_restartLearningWindowTimer", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restLpsLPSConfigurationRestartLearningWindowTimer" }, "task": true }, { "name": "restLpsLearnedPortSecurityConvertToStatic", "summary": "rest_lps_LearnedPortSecurity_convertToStatic", "description": "rest_lps_LearnedPortSecurity_convertToStatic", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restLpsLearnedPortSecurityConvertToStatic" }, "task": true }, { "name": "restLpsLearnedPortSecurityReleaseViolatedPort", "summary": "rest_lps_LearnedPortSecurity_releaseViolatedPort", "description": "rest_lps_LearnedPortSecurity_releaseViolatedPort", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restLpsLearnedPortSecurityReleaseViolatedPort" }, "task": true }, { "name": "restLteEPSPathDrillDown", "summary": "rest_lte_EPSPath_drillDown", "description": "rest_lte_EPSPath_drillDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restLteEPSPathDrillDown" }, "task": true }, { "name": "restLteEPSPathDrillDownPaths", "summary": "rest_lte_EPSPath_drillDownPaths", "description": "rest_lte_EPSPath_drillDownPaths", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restLteEPSPathDrillDownPaths" }, "task": true }, { "name": "restLteEPSPeerCreateMobileService", "summary": "rest_lte_EPSPeer_createMobileService", "description": "rest_lte_EPSPeer_createMobileService", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restLteEPSPeerCreateMobileService" }, "task": true }, { "name": "restLteMmeEpsPeerSummaryRetrieveEnbLinkStatus", "summary": "retrieveEnbLinkStatus", "description": "Query the list of links from a WMM CMM with the specified siteId to an eNB matching the MCC, MNC and macroEnbId Intention : RETRIEVER retrieveEnbLinkStatus: class-level retriever API retrieveEnbLinkStatus of class lte.MmeEpsPeerSummary", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"epsType\": \"string\", \"mcc\": \"string\", \"mnc\": \"string\", \"macroEnbId\": 123}", "required": false, "schema": { "type": "object", "required": [ "epsType", "macroEnbId", "mcc", "mnc", "siteId" ], "properties": { "siteId": { "type": "string", "description": " " }, "epsType": { "type": "string", "description": " " }, "mcc": { "type": "string", "description": " " }, "mnc": { "type": "string", "description": " " }, "macroEnbId": { "type": "integer", "description": " " } }, "description": "Model containing the method level model for MmeEpsPeerSummary.retrieveEnbLinkStatus to decode json data to internal NFM-P object model" } } ], "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": "/restLteMmeEpsPeerSummaryRetrieveEnbLinkStatus" }, "task": true }, { "name": "restLteMmeEpsPeerSummaryRetrieveEpsPeers", "summary": "retrieveEpsPeers", "description": "Query a list of High Volume EPS Peers whose type are the same as the querying EPS Peer Summary instance. Results will be stored in a list of temporary Info Objects and will not be stored in the NFM-P Data Base. To ignore filtering results based on either AdminState or OperState, set the parameter to '0'. WARNING: Depending on the number of peers present on the node, once you start the retrieval process, the task may be large and may take several minutes to complete. Intention : RETRIEVER retr...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"epsType\": \"string\", \"terminationName\": \"string\", \"adminState\": \"string\", \"operationalState\": \"string\", \"linkAlarm\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "adminState", "epsType", "linkAlarm", "operationalState", "siteId", "terminationName" ], "properties": { "siteId": { "type": "string", "description": " " }, "epsType": { "type": "string", "description": " " }, "terminationName": { "type": "string", "description": " " }, "adminState": { "type": "string", "description": " " }, "operationalState": { "type": "string", "description": " " }, "linkAlarm": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for MmeEpsPeerSummary.retrieveEpsPeers to decode json data to internal NFM-P object model" } } ], "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": "/restLteMmeEpsPeerSummaryRetrieveEpsPeers" }, "task": true }, { "name": "restLteMmeEpsPeerSummarySetEpsPeerAdminState", "summary": "rest_lte_MmeEpsPeerSummary_setEpsPeerAdminState", "description": "rest_lte_MmeEpsPeerSummary_setEpsPeerAdminState", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"epsType\": \"string\", \"linkIndex\": 123, \"adminState\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "adminState", "epsType", "linkIndex", "siteId" ], "properties": { "siteId": { "type": "string", "description": " " }, "epsType": { "type": "string", "description": " " }, "linkIndex": { "type": "integer", "description": " " }, "adminState": { "type": "string", "description": " " } }, "description": "Model containing the method level model for MmeEpsPeerSummary.setEpsPeerAdminState to decode json data to internal NFM-P object model" } } ], "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": "/restLteMmeEpsPeerSummarySetEpsPeerAdminState" }, "task": true }, { "name": "restLtePDNGatewayFindAllNetworkElementsHavingPDNGateways", "summary": "findAllNetworkElementsHavingPDNGateways", "description": "Find all the Network elements that -all- the PDNGateways belong to Intention : RETRIEVER findAllNetworkElementsHavingPDNGateways: class-level [object finder] (retriever) API findAllNetworkElementsHavingPDNGateways of class lte.PDNGateway", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restLtePDNGatewayFindAllNetworkElementsHavingPDNGateways" }, "task": true }, { "name": "restLtecmmCMMInstanceAmfDirectedUELoadBalance", "summary": "rest_ltecmm_CMMInstance_amfDirectedUELoadBalance", "description": "rest_ltecmm_CMMInstance_amfDirectedUELoadBalance", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"amfDirectedUelbProfileName\": \"string\", \"amfUelbAction\": \"string\", \"requestId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "amfDirectedUelbProfileName", "amfUelbAction", "siteId" ], "properties": { "siteId": { "type": "string", "description": " " }, "amfDirectedUelbProfileName": { "type": "string", "description": " " }, "amfUelbAction": { "type": "string", "description": " " }, "requestId": { "type": "string", "description": "Non documentable API" } }, "description": "Model containing the method level model for CMMInstance.amfDirectedUELoadBalance to decode json data to internal NFM-P object model" } } ], "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": "/restLtecmmCMMInstanceAmfDirectedUELoadBalance" }, "task": true }, { "name": "restLtecmmCMMInstanceRetrieveAllPM", "summary": "rest_ltecmm_CMMInstance_retrieveAllPM", "description": "rest_ltecmm_CMMInstance_retrieveAllPM", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restLtecmmCMMInstanceRetrieveAllPM" }, "task": true }, { "name": "restLtecmmCMMInstanceRetrieveSigNodeAdmin", "summary": "retrieveSigNodeAdmin", "description": "Intention : RETRIEVER retrieveSigNodeAdmin: class-level retriever API retrieveSigNodeAdmin of class ltecmm.CMMInstance", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"sigNodeTypeFlags\": \"array\", \"networkTechType\": \"string\", \"gwtsName\": \"string\", \"requestId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "gwtsName", "networkTechType", "sigNodeTypeFlags", "siteId" ], "properties": { "siteId": { "type": "string", "description": " " }, "sigNodeTypeFlags": { "type": "array", "description": " default:0", "items": { "type": "string" } }, "networkTechType": { "type": "string", "description": " default:lte" }, "gwtsName": { "type": "string", "description": " default:" }, "requestId": { "type": "string", "description": "Non documentable API" } }, "description": "Model containing the method level model for CMMInstance.retrieveSigNodeAdmin to decode json data to internal NFM-P object model" } } ], "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": "/restLtecmmCMMInstanceRetrieveSigNodeAdmin" }, "task": true }, { "name": "restLtecmmCMMInstanceSetAggregateAdminState", "summary": "rest_ltecmm_CMMInstance_setAggregateAdminState", "description": "rest_ltecmm_CMMInstance_setAggregateAdminState", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"adminState\": \"string\", \"clientId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "adminState", "siteId" ], "properties": { "siteId": { "type": "string", "description": " " }, "adminState": { "type": "string", "description": " " }, "clientId": { "type": "string", "description": "Non documentable API" } }, "description": "Model containing the method level model for CMMInstance.setAggregateAdminState to decode json data to internal NFM-P object model" } } ], "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": "/restLtecmmCMMInstanceSetAggregateAdminState" }, "task": true }, { "name": "restLtecmmCMMInstanceSetGwAdminState", "summary": "rest_ltecmm_CMMInstance_setGwAdminState", "description": "rest_ltecmm_CMMInstance_setGwAdminState", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"sigNodeType\": \"string\", \"networkTechType\": \"string\", \"nodeIndex\": 123, \"adminState\": \"string\", \"clientId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "adminState", "networkTechType", "nodeIndex", "sigNodeType", "siteId" ], "properties": { "siteId": { "type": "string", "description": " " }, "sigNodeType": { "type": "string", "description": " " }, "networkTechType": { "type": "string", "description": " default:lte" }, "nodeIndex": { "type": "integer", "description": " " }, "adminState": { "type": "string", "description": " " }, "clientId": { "type": "string", "description": "Non documentable API" } }, "description": "Model containing the method level model for CMMInstance.setGwAdminState to decode json data to internal NFM-P object model" } } ], "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": "/restLtecmmCMMInstanceSetGwAdminState" }, "task": true }, { "name": "restLtecmmCMMInstanceSetGwtsAdminState", "summary": "rest_ltecmm_CMMInstance_setGwtsAdminState", "description": "rest_ltecmm_CMMInstance_setGwtsAdminState", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"gwtsName\": \"string\", \"adminState\": \"string\", \"clientId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "adminState", "gwtsName", "siteId" ], "properties": { "siteId": { "type": "string", "description": " " }, "gwtsName": { "type": "string", "description": " " }, "adminState": { "type": "string", "description": " " }, "clientId": { "type": "string", "description": "Non documentable API" } }, "description": "Model containing the method level model for CMMInstance.setGwtsAdminState to decode json data to internal NFM-P object model" } } ], "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": "/restLtecmmCMMInstanceSetGwtsAdminState" }, "task": true }, { "name": "restLteuserstatsUserStatsManagerCancelAllQueries", "summary": "rest_lteuserstats_UserStatsManager_cancelAllQueries", "description": "rest_lteuserstats_UserStatsManager_cancelAllQueries", "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": "/restLteuserstatsUserStatsManagerCancelAllQueries" }, "task": true }, { "name": "restLteuserstatsUserStatsManagerRemoveAllQueries", "summary": "rest_lteuserstats_UserStatsManager_removeAllQueries", "description": "rest_lteuserstats_UserStatsManager_removeAllQueries", "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": "/restLteuserstatsUserStatsManagerRemoveAllQueries" }, "task": true }, { "name": "restLteuserstatsUserStatsQueryExecuteQueryOnList", "summary": "rest_lteuserstats_UserStatsQuery_executeQueryOnList", "description": "rest_lteuserstats_UserStatsQuery_executeQueryOnList", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restLteuserstatsUserStatsQueryExecuteQueryOnList" }, "task": true }, { "name": "restLteuserstatsUserStatsQueryShouldWarnUser", "summary": "shouldWarnUser", "description": "Intention : RETRIEVER shouldWarnUser: class-level retriever API shouldWarnUser of class lteuserstats.UserStatsQuery", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restLteuserstatsUserStatsQueryShouldWarnUser" }, "task": true }, { "name": "restMacsecCASiteSyncWithGlobal", "summary": "rest_macsec_CASite_syncWithGlobal", "description": "rest_macsec_CASite_syncWithGlobal", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMacsecCASiteSyncWithGlobal" }, "task": true }, { "name": "restMacsecConnectivityAssociationAddCASites", "summary": "rest_macsec_ConnectivityAssociation_addCASites", "description": "rest_macsec_ConnectivityAssociation_addCASites", "input": [ { "name": "body", "type": "object", "info": ": {\"siteIdList\": \"array\", \"caFullName\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "caFullName", "siteIdList" ], "properties": { "siteIdList": { "type": "array", "description": " List of siteIds.", "items": { "type": "string" } }, "caFullName": { "type": "string", "description": " " } }, "description": "Model containing the method level model for ConnectivityAssociation.addCASites to decode json data to internal NFM-P object model" } } ], "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": "/restMacsecConnectivityAssociationAddCASites" }, "task": true }, { "name": "restMacsecConnectivityAssociationDeleteCASites", "summary": "rest_macsec_ConnectivityAssociation_deleteCASites", "description": "rest_macsec_ConnectivityAssociation_deleteCASites", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMacsecConnectivityAssociationDeleteCASites" }, "task": true }, { "name": "restMacsecConnectivityAssociationResetInProgressKeyingStatus", "summary": "rest_macsec_ConnectivityAssociation_resetInProgressKeyingStatus", "description": "rest_macsec_ConnectivityAssociation_resetInProgressKeyingStatus", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMacsecConnectivityAssociationResetInProgressKeyingStatus" }, "task": true }, { "name": "restMacsecMacSecScheduledTaskStartRekey", "summary": "rest_macsec_MacSecScheduledTask_startRekey", "description": "rest_macsec_MacSecScheduledTask_startRekey", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMacsecMacSecScheduledTaskStartRekey" }, "task": true }, { "name": "restMacsecMacsecInterfaceRemoveMacsecInterfacesFromCA", "summary": "rest_macsec_MacsecInterface_removeMacsecInterfacesFromCA", "description": "rest_macsec_MacsecInterface_removeMacsecInterfacesFromCA", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMacsecMacsecInterfaceRemoveMacsecInterfacesFromCA" }, "task": true }, { "name": "restMacsecStaticCAKCreatePsk", "summary": "rest_macsec_StaticCAK_createPsk", "description": "rest_macsec_StaticCAK_createPsk", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInPskIndex\": 123, \"aInEncryptionType\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInPskIndex": { "type": "integer" }, "aInEncryptionType": { "type": "string" } }, "description": "Model containing the method level model for StaticCAK.createPsk to decode json data to internal NFM-P object model" } } ], "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": "/restMacsecStaticCAKCreatePsk" }, "task": true }, { "name": "restMacsecStaticCAKDeletePsk", "summary": "rest_macsec_StaticCAK_deletePsk", "description": "rest_macsec_StaticCAK_deletePsk", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restMacsecStaticCAKDeletePsk" }, "task": true }, { "name": "restMacsecStaticCAKDistributePSKs", "summary": "rest_macsec_StaticCAK_distributePSKs", "description": "rest_macsec_StaticCAK_distributePSKs", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMacsecStaticCAKDistributePSKs" }, "task": true }, { "name": "restMacsecStaticCAKSyncWithGlobal", "summary": "rest_macsec_StaticCAK_syncWithGlobal", "description": "rest_macsec_StaticCAK_syncWithGlobal", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMacsecStaticCAKSyncWithGlobal" }, "task": true }, { "name": "restMdaxconnectMdaXconnectMacFindAnchorPorts", "summary": "findAnchorPorts", "description": "Intention : RETRIEVER findAnchorPorts: instance-level [object finder] (retriever) API findAnchorPorts of class mdaxconnect.MdaXconnectMac instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMdaxconnectMdaXconnectMacFindAnchorPorts" }, "task": true }, { "name": "restMdaxconnectMdaXconnectMacFindLoopbacks", "summary": "findLoopbacks", "description": "Intention : RETRIEVER findLoopbacks: instance-level [object finder] (retriever) API findLoopbacks of class mdaxconnect.MdaXconnectMac instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMdaxconnectMdaXconnectMacFindLoopbacks" }, "task": true }, { "name": "restMdaxconnectMdaXconnectMacGetDependencyCount", "summary": "getDependencyCount", "description": "Intention : RETRIEVER getDependencyCount: instance-level retriever API getDependencyCount of class mdaxconnect.MdaXconnectMac instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMdaxconnectMdaXconnectMacGetDependencyCount" }, "task": true }, { "name": "restMediationBackupPolicyConfigure", "summary": "rest_mediation_BackupPolicy_configure", "description": "rest_mediation_BackupPolicy_configure", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"enableBackup\": \"boolean\", \"backupMode\": 123, \"policyType\": 123, \"autoBackupScheme\": 123, \"policyId\": 123, \"displayedName\": \"string\", \"autoBackupSchemeTreshold\": 123, \"scheduledBackupScheme\": 123, \"scheduledBackupTreshold\": 123, \"scheduledBackupFrequency\": 123, \"scheduledBackupSyncTime\": 123, \"cliConfigFileBackupMode\": 123, \"debugConfigFileBackupMode\": \"boolean\", \"bootOptionFileBackupMode\": 123, \"isAutoReboot\": \"boolean\", \"cliConfigSaveDetails\": \"boolean\", \"compressionMode\": 123, \"purgeMode\": 123, \"numBackupsToKeep\": 123, \"maxBackupAge\": 123, \"saveCertifyDir\": \"boolean\", \"commandToApply\": 123, \"saveNetworkDir\": \"boolean\", \"saveSystemDir\": \"boolean\", \"restoreDirectory\": \"string\", \"ftpUser\": \"string\", \"ftpPassword\": \"string\", \"ftpServerIPAddrType\": 123, \"ftpServerIP\": \"string\", \"ftpServerPort\": 123, \"ftpRootDir\": \"string\", \"ftpType\": 123, \"sshHostKeyFingerPrint\": \"string\", \"useActiveServer\": \"boolean\", \"sarRadioDbFileBackupMode\": \"boolean\", \"cliAdminSave\": \"boolean\", \"backupCertificates\": \"boolean\", \"backupRollbackFiles\": \"boolean\", \"backupTSFiles\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "enableBackup": { "type": "boolean", "default": false }, "backupMode": { "type": "integer" }, "policyType": { "type": "integer" }, "autoBackupScheme": { "type": "integer" }, "policyId": { "type": "integer" }, "displayedName": { "type": "string" }, "autoBackupSchemeTreshold": { "type": "integer" }, "scheduledBackupScheme": { "type": "integer" }, "scheduledBackupTreshold": { "type": "integer" }, "scheduledBackupFrequency": { "type": "integer" }, "scheduledBackupSyncTime": { "type": "integer" }, "cliConfigFileBackupMode": { "type": "integer" }, "debugConfigFileBackupMode": { "type": "boolean", "default": false }, "bootOptionFileBackupMode": { "type": "integer" }, "isAutoReboot": { "type": "boolean", "default": false }, "cliConfigSaveDetails": { "type": "boolean", "default": false }, "compressionMode": { "type": "integer" }, "purgeMode": { "type": "integer" }, "numBackupsToKeep": { "type": "integer" }, "maxBackupAge": { "type": "integer" }, "saveCertifyDir": { "type": "boolean", "default": false }, "commandToApply": { "type": "integer" }, "saveNetworkDir": { "type": "boolean", "default": false }, "saveSystemDir": { "type": "boolean", "default": false }, "restoreDirectory": { "type": "string" }, "ftpUser": { "type": "string" }, "ftpPassword": { "type": "string" }, "ftpServerIPAddrType": { "type": "integer" }, "ftpServerIP": { "type": "string" }, "ftpServerPort": { "type": "integer" }, "ftpRootDir": { "type": "string" }, "ftpType": { "type": "integer" }, "sshHostKeyFingerPrint": { "type": "string" }, "useActiveServer": { "type": "boolean", "default": false }, "sarRadioDbFileBackupMode": { "type": "boolean", "default": false }, "cliAdminSave": { "type": "boolean", "default": false }, "backupCertificates": { "type": "boolean", "default": false }, "backupRollbackFiles": { "type": "boolean", "default": false }, "backupTSFiles": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface ConfigInfo BackupPolicyConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restMediationBackupPolicyConfigure" }, "task": true }, { "name": "restMediationDeploymentPolicyConfigure", "summary": "rest_mediation_DeploymentPolicy_configure", "description": "rest_mediation_DeploymentPolicy_configure", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"deploymentMode\": 123, \"autoSaveConfigScheme\": 123, \"autoSaveConfigTreshold\": 123, \"scheduledSaveConfigScheme\": 123, \"scheduledSaveConfigFrequency\": 123, \"retryScheme\": 123, \"retryFrequency\": 123, \"retryThreshold\": 123, \"saveConfigDetails\": \"boolean\", \"saveConfigInterval\": 123, \"saveConfigScheduling\": 123}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "deploymentMode": { "type": "integer" }, "autoSaveConfigScheme": { "type": "integer" }, "autoSaveConfigTreshold": { "type": "integer" }, "scheduledSaveConfigScheme": { "type": "integer" }, "scheduledSaveConfigFrequency": { "type": "integer" }, "retryScheme": { "type": "integer" }, "retryFrequency": { "type": "integer" }, "retryThreshold": { "type": "integer" }, "saveConfigDetails": { "type": "boolean", "default": false }, "saveConfigInterval": { "type": "integer" }, "saveConfigScheduling": { "type": "integer" } }, "description": "Model containing the method level model for Interface ConfigInfo DeploymentPolicyConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restMediationDeploymentPolicyConfigure" }, "task": true }, { "name": "restMediationDeploymentPolicyGetInfo", "summary": "getInfo", "description": "Intention : ACCESSOR getInfo: instance-level accessor API getInfo on default instance Default.DeployerBank:policy of class mediation.DeploymentPolicy", "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": "/restMediationDeploymentPolicyGetInfo" }, "task": true }, { "name": "restMediationFirmwareFolderDescriptorActivateFirmwareImage", "summary": "rest_mediation_FirmwareFolderDescriptor_activateFirmwareImage", "description": "rest_mediation_FirmwareFolderDescriptor_activateFirmwareImage", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"networkElements\": \"array\", \"simId\": 123}", "required": false, "schema": { "type": "object", "required": [ "networkElements", "simId" ], "properties": { "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "simId": { "type": "integer", "description": " default:1" } }, "description": "Model containing the method level model for FirmwareFolderDescriptor.activateFirmwareImage to decode json data to internal NFM-P object model" } } ], "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": "/restMediationFirmwareFolderDescriptorActivateFirmwareImage" }, "task": true }, { "name": "restMediationFirmwareFolderDescriptorFindFirmwareApplicableNes", "summary": "findFirmwareApplicableNes", "description": "Used to find list network elements that could be upgraded using this image. Intention : RETRIEVER findFirmwareApplicableNes: instance-level [object finder] (retriever) API findFirmwareApplicableNes of class mediation.FirmwareFolderDescriptor instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "isScheduled", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "isScheduled", "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": "/restMediationFirmwareFolderDescriptorFindFirmwareApplicableNes" }, "task": true }, { "name": "restMediationFirmwareFolderDescriptorScheduleFirmwareUpgrade", "summary": "rest_mediation_FirmwareFolderDescriptor_scheduleFirmwareUpgrade", "description": "rest_mediation_FirmwareFolderDescriptor_scheduleFirmwareUpgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"schedule\": \"string\", \"networkElements\": \"array\", \"simId\": 123}", "required": false, "schema": { "type": "object", "required": [ "networkElements", "schedule", "simId" ], "properties": { "schedule": { "type": "string", "description": " " }, "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "simId": { "type": "integer", "description": " default:1" } }, "description": "Model containing the method level model for FirmwareFolderDescriptor.scheduleFirmwareUpgrade to decode json data to internal NFM-P object model" } } ], "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": "/restMediationFirmwareFolderDescriptorScheduleFirmwareUpgrade" }, "task": true }, { "name": "restMediationFirmwareFolderDescriptorUpgradeFirmware", "summary": "rest_mediation_FirmwareFolderDescriptor_upgradeFirmware", "description": "rest_mediation_FirmwareFolderDescriptor_upgradeFirmware", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"networkElements\": \"array\", \"simId\": 123}", "required": false, "schema": { "type": "object", "required": [ "networkElements", "simId" ], "properties": { "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "simId": { "type": "integer", "description": " default:1" } }, "description": "Model containing the method level model for FirmwareFolderDescriptor.upgradeFirmware to decode json data to internal NFM-P object model" } } ], "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": "/restMediationFirmwareFolderDescriptorUpgradeFirmware" }, "task": true }, { "name": "restMediationFirmwareFolderDescriptorValidateFirmwareDiskSpace", "summary": "rest_mediation_FirmwareFolderDescriptor_validateFirmwareDiskSpace", "description": "rest_mediation_FirmwareFolderDescriptor_validateFirmwareDiskSpace", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationFirmwareFolderDescriptorValidateFirmwareDiskSpace" }, "task": true }, { "name": "restMediationGNESoftwareFolderDescriptorFindApplicableNes", "summary": "findApplicableNes", "description": "Used to find list network elements that could be upgraded using this image. Intention : RETRIEVER findApplicableNes: instance-level [object finder] (retriever) API findApplicableNes of class mediation.GNESoftwareFolderDescriptor instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "isScheduled", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "isScheduled", "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": "/restMediationGNESoftwareFolderDescriptorFindApplicableNes" }, "task": true }, { "name": "restMediationGNESoftwareFolderDescriptorFindApplicableOperations", "summary": "findApplicableOperations", "description": "Used to find list upgrade operations that could be performed using this image. Intention : RETRIEVER findApplicableOperations: instance-level [object finder] (retriever) API findApplicableOperations of class mediation.GNESoftwareFolderDescriptor instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "isScheduled", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "isScheduled", "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": "/restMediationGNESoftwareFolderDescriptorFindApplicableOperations" }, "task": true }, { "name": "restMediationGNESoftwareFolderDescriptorScheduleUpgrade", "summary": "rest_mediation_GNESoftwareFolderDescriptor_scheduleUpgrade", "description": "rest_mediation_GNESoftwareFolderDescriptor_scheduleUpgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"schedule\": \"string\", \"networkElements\": \"array\", \"isConcurrent\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "isConcurrent", "networkElements", "schedule" ], "properties": { "schedule": { "type": "string", "description": " " }, "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "isConcurrent": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for OCSSoftwareFolderDescriptor.scheduleUpgrade to decode json data to internal NFM-P object model" } } ], "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": "/restMediationGNESoftwareFolderDescriptorScheduleUpgrade" }, "task": true }, { "name": "restMediationGNESoftwareFolderDescriptorUpgrade", "summary": "rest_mediation_GNESoftwareFolderDescriptor_upgrade", "description": "rest_mediation_GNESoftwareFolderDescriptor_upgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"networkElements\": \"array\", \"isSynchronised\": \"boolean\", \"clientId\": \"string\", \"upgradeState\": 123}", "required": false, "schema": { "type": "object", "required": [ "clientId", "isSynchronised", "networkElements", "upgradeState" ], "properties": { "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "isSynchronised": { "type": "boolean", "description": " Identifies if the call to execute the script should wait until all scripts have been executed.True to wait, false otherwise.", "default": false }, "clientId": { "type": "string", "description": " Identifies the client Id that is requesting the execution(used for sending an event to the specific client when execution is complete)." }, "upgradeState": { "type": "integer", "description": " Identifies the SU Stage to perform." } }, "description": "Model containing the method level model for MMESoftwareFolderDescriptor.upgrade to decode json data to internal NFM-P object model" } } ], "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": "/restMediationGNESoftwareFolderDescriptorUpgrade" }, "task": true }, { "name": "restMediationMMESoftwareFolderDescriptorBackout", "summary": "rest_mediation_MMESoftwareFolderDescriptor_backout", "description": "rest_mediation_MMESoftwareFolderDescriptor_backout", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"isSynchronised\": \"boolean\", \"clientId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "clientId", "isSynchronised", "siteId" ], "properties": { "siteId": { "type": "string", "description": " Identifies the siteId of the WMM node to perform the Backout on." }, "isSynchronised": { "type": "boolean", "description": " Identifies if the call to execute the script should wait until all scripts have been executed.True to wait, false otherwise.", "default": false }, "clientId": { "type": "string", "description": " Identifies the client Id that is requesting the execution(used for sending an event to the specific client when execution is complete)." } }, "description": "Model containing the method level model for MMESoftwareFolderDescriptor.backout to decode json data to internal NFM-P object model" } } ], "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": "/restMediationMMESoftwareFolderDescriptorBackout" }, "task": true }, { "name": "restMediationMMESoftwareFolderDescriptorCommit", "summary": "rest_mediation_MMESoftwareFolderDescriptor_commit", "description": "rest_mediation_MMESoftwareFolderDescriptor_commit", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"isSynchronised\": \"boolean\", \"clientId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "clientId", "isSynchronised", "siteId" ], "properties": { "siteId": { "type": "string", "description": " Identifies the siteId of the WMM node to perform the commit on." }, "isSynchronised": { "type": "boolean", "description": " Identifies if the call to execute the script should wait until all scripts have been executed.True to wait, false otherwise.", "default": false }, "clientId": { "type": "string", "description": " Identifies the client Id that is requesting the execution(used for sending an event to the specific client when execution is complete)." } }, "description": "Model containing the method level model for MMESoftwareFolderDescriptor.commit to decode json data to internal NFM-P object model" } } ], "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": "/restMediationMMESoftwareFolderDescriptorCommit" }, "task": true }, { "name": "restMediationMMESoftwareFolderDescriptorContinueExecutingSU", "summary": "rest_mediation_MMESoftwareFolderDescriptor_continueExecutingSU", "description": "rest_mediation_MMESoftwareFolderDescriptor_continueExecutingSU", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"isSynchronised\": \"boolean\", \"clientId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "clientId", "isSynchronised", "siteId" ], "properties": { "siteId": { "type": "string", "description": " Identifies the siteId of the WMM node to perform the continue on." }, "isSynchronised": { "type": "boolean", "description": " Identifies if the call to execute the script should wait until all scripts have been executed.True to wait, false otherwise.", "default": false }, "clientId": { "type": "string", "description": " Identifies the client Id that is requesting the execution(used for sending an event to the specific client when execution is complete)." } }, "description": "Model containing the method level model for MMESoftwareFolderDescriptor.continueExecutingSU to decode json data to internal NFM-P object model" } } ], "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": "/restMediationMMESoftwareFolderDescriptorContinueExecutingSU" }, "task": true }, { "name": "restMediationMMESoftwareFolderDescriptorScheduleUpgrade", "summary": "rest_mediation_MMESoftwareFolderDescriptor_scheduleUpgrade", "description": "rest_mediation_MMESoftwareFolderDescriptor_scheduleUpgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"schedule\": \"string\", \"networkElements\": \"array\", \"isConcurrent\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "isConcurrent", "networkElements", "schedule" ], "properties": { "schedule": { "type": "string", "description": " " }, "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "isConcurrent": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for OCSSoftwareFolderDescriptor.scheduleUpgrade to decode json data to internal NFM-P object model" } } ], "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": "/restMediationMMESoftwareFolderDescriptorScheduleUpgrade" }, "task": true }, { "name": "restMediationMMESoftwareFolderDescriptorUpgrade", "summary": "rest_mediation_MMESoftwareFolderDescriptor_upgrade", "description": "rest_mediation_MMESoftwareFolderDescriptor_upgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"networkElements\": \"array\", \"isSynchronised\": \"boolean\", \"clientId\": \"string\", \"upgradeState\": 123}", "required": false, "schema": { "type": "object", "required": [ "clientId", "isSynchronised", "networkElements", "upgradeState" ], "properties": { "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "isSynchronised": { "type": "boolean", "description": " Identifies if the call to execute the script should wait until all scripts have been executed.True to wait, false otherwise.", "default": false }, "clientId": { "type": "string", "description": " Identifies the client Id that is requesting the execution(used for sending an event to the specific client when execution is complete)." }, "upgradeState": { "type": "integer", "description": " Identifies the SU Stage to perform." } }, "description": "Model containing the method level model for MMESoftwareFolderDescriptor.upgrade to decode json data to internal NFM-P object model" } } ], "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": "/restMediationMMESoftwareFolderDescriptorUpgrade" }, "task": true }, { "name": "restMediationMPRSoftwareFolderDescriptorAbortUpgrade", "summary": "rest_mediation_MPRSoftwareFolderDescriptor_abortUpgrade", "description": "rest_mediation_MPRSoftwareFolderDescriptor_abortUpgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationMPRSoftwareFolderDescriptorAbortUpgrade" }, "task": true }, { "name": "restMediationMPRSoftwareFolderDescriptorScheduleUpgrade", "summary": "rest_mediation_MPRSoftwareFolderDescriptor_scheduleUpgrade", "description": "rest_mediation_MPRSoftwareFolderDescriptor_scheduleUpgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"schedule\": \"string\", \"networkElements\": \"array\", \"isConcurrent\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "isConcurrent", "networkElements", "schedule" ], "properties": { "schedule": { "type": "string", "description": " " }, "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "isConcurrent": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for OCSSoftwareFolderDescriptor.scheduleUpgrade to decode json data to internal NFM-P object model" } } ], "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": "/restMediationMPRSoftwareFolderDescriptorScheduleUpgrade" }, "task": true }, { "name": "restMediationMPRSoftwareFolderDescriptorUpgrade", "summary": "rest_mediation_MPRSoftwareFolderDescriptor_upgrade", "description": "rest_mediation_MPRSoftwareFolderDescriptor_upgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationMPRSoftwareFolderDescriptorUpgrade" }, "task": true }, { "name": "restMediationManagementPingDestinationPing", "summary": "rest_mediation_ManagementPingDestination_ping", "description": "rest_mediation_ManagementPingDestination_ping", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMediationManagementPingDestinationPing" }, "task": true }, { "name": "restMediationManagementPingDestinationPingAndGetResult", "summary": "pingAndGetResult", "description": "Execute network element reachability test and return the ping status enum {{mediation.PingStatus}}. It waits for the result and then returns so there may be delay due to network or timeout. Intention : RETRIEVER pingAndGetResult: instance-level retriever API pingAndGetResult of class mediation.ManagementPingDestination instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMediationManagementPingDestinationPingAndGetResult" }, "task": true }, { "name": "restMediationOCSSoftwareFolderDescriptorAbort", "summary": "rest_mediation_OCSSoftwareFolderDescriptor_abort", "description": "rest_mediation_OCSSoftwareFolderDescriptor_abort", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationOCSSoftwareFolderDescriptorAbort" }, "task": true }, { "name": "restMediationOCSSoftwareFolderDescriptorActivate", "summary": "rest_mediation_OCSSoftwareFolderDescriptor_activate", "description": "rest_mediation_OCSSoftwareFolderDescriptor_activate", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"sessionFdn\": \"string\", \"neWorkOrders\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "neWorkOrders", "sessionFdn" ], "properties": { "sessionFdn": { "type": "string", "description": " The session to validate." }, "neWorkOrders": { "type": "array", "description": " The set of NE work orders to validate. The NE work orders must be in the given session.", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for Session.activate to decode json data to internal NFM-P object model" } } ], "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": "/restMediationOCSSoftwareFolderDescriptorActivate" }, "task": true }, { "name": "restMediationOCSSoftwareFolderDescriptorActivateGmre", "summary": "rest_mediation_OCSSoftwareFolderDescriptor_activateGmre", "description": "rest_mediation_OCSSoftwareFolderDescriptor_activateGmre", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restMediationOCSSoftwareFolderDescriptorActivateGmre" }, "task": true }, { "name": "restMediationOCSSoftwareFolderDescriptorAudit", "summary": "rest_mediation_OCSSoftwareFolderDescriptor_audit", "description": "rest_mediation_OCSSoftwareFolderDescriptor_audit", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"networkElements\": \"array\", \"auditSettings\": 123}", "required": false, "schema": { "type": "object", "required": [ "auditSettings", "networkElements" ], "properties": { "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "auditSettings": { "type": "integer", "description": " This parameter will pickup the local audit settings details defining Default Audit Settings Force Upgrade Only Node Backup Only Both Force Upgrade and Node Backup None." } }, "description": "Model containing the method level model for OCSSoftwareFolderDescriptor.audit to decode json data to internal NFM-P object model" } } ], "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": "/restMediationOCSSoftwareFolderDescriptorAudit" }, "task": true }, { "name": "restMediationOCSSoftwareFolderDescriptorAutoUpgrade", "summary": "rest_mediation_OCSSoftwareFolderDescriptor_autoUpgrade", "description": "rest_mediation_OCSSoftwareFolderDescriptor_autoUpgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"networkElements\": \"array\", \"auditSettings\": 123, \"isConcurrent\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "auditSettings", "isConcurrent", "networkElements" ], "properties": { "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "auditSettings": { "type": "integer", "description": " This parameter will pickup the local audit settings details defining Default Audit Settings Force Upgrade Only Node Backup Only Both Force Upgrade and Node Backup None." }, "isConcurrent": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for OCSSoftwareFolderDescriptor.autoUpgrade to decode json data to internal NFM-P object model" } } ], "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": "/restMediationOCSSoftwareFolderDescriptorAutoUpgrade" }, "task": true }, { "name": "restMediationOCSSoftwareFolderDescriptorCommit", "summary": "rest_mediation_OCSSoftwareFolderDescriptor_commit", "description": "rest_mediation_OCSSoftwareFolderDescriptor_commit", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationOCSSoftwareFolderDescriptorCommit" }, "task": true }, { "name": "restMediationOCSSoftwareFolderDescriptorDownload", "summary": "rest_mediation_OCSSoftwareFolderDescriptor_download", "description": "rest_mediation_OCSSoftwareFolderDescriptor_download", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationOCSSoftwareFolderDescriptorDownload" }, "task": true }, { "name": "restMediationOCSSoftwareFolderDescriptorRevert", "summary": "rest_mediation_OCSSoftwareFolderDescriptor_revert", "description": "rest_mediation_OCSSoftwareFolderDescriptor_revert", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationOCSSoftwareFolderDescriptorRevert" }, "task": true }, { "name": "restMediationOCSSoftwareFolderDescriptorScheduleUpgrade", "summary": "rest_mediation_OCSSoftwareFolderDescriptor_scheduleUpgrade", "description": "rest_mediation_OCSSoftwareFolderDescriptor_scheduleUpgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"schedule\": \"string\", \"networkElements\": \"array\", \"isConcurrent\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "isConcurrent", "networkElements", "schedule" ], "properties": { "schedule": { "type": "string", "description": " " }, "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "isConcurrent": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for OCSSoftwareFolderDescriptor.scheduleUpgrade to decode json data to internal NFM-P object model" } } ], "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": "/restMediationOCSSoftwareFolderDescriptorScheduleUpgrade" }, "task": true }, { "name": "restMediationOmniSoftwareFolderDescriptorCertifyImage", "summary": "rest_mediation_OmniSoftwareFolderDescriptor_certifyImage", "description": "rest_mediation_OmniSoftwareFolderDescriptor_certifyImage", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationOmniSoftwareFolderDescriptorCertifyImage" }, "task": true }, { "name": "restMediationOmniSoftwareFolderDescriptorDeleteUbootMiniBoot", "summary": "rest_mediation_OmniSoftwareFolderDescriptor_deleteUbootMiniBoot", "description": "rest_mediation_OmniSoftwareFolderDescriptor_deleteUbootMiniBoot", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationOmniSoftwareFolderDescriptorDeleteUbootMiniBoot" }, "task": true }, { "name": "restMediationOmniSoftwareFolderDescriptorInstallImage", "summary": "rest_mediation_OmniSoftwareFolderDescriptor_installImage", "description": "rest_mediation_OmniSoftwareFolderDescriptor_installImage", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationOmniSoftwareFolderDescriptorInstallImage" }, "task": true }, { "name": "restMediationOmniSoftwareFolderDescriptorReload", "summary": "rest_mediation_OmniSoftwareFolderDescriptor_reload", "description": "rest_mediation_OmniSoftwareFolderDescriptor_reload", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"networkElements\": \"array\", \"isIssu\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "isIssu", "networkElements" ], "properties": { "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "isIssu": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for OmniSoftwareFolderDescriptor.reload to decode json data to internal NFM-P object model" } } ], "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": "/restMediationOmniSoftwareFolderDescriptorReload" }, "task": true }, { "name": "restMediationOmniSoftwareFolderDescriptorUpgrade", "summary": "rest_mediation_OmniSoftwareFolderDescriptor_upgrade", "description": "rest_mediation_OmniSoftwareFolderDescriptor_upgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"networkElements\": \"array\", \"isSynchronised\": \"boolean\", \"clientId\": \"string\", \"upgradeState\": 123}", "required": false, "schema": { "type": "object", "required": [ "clientId", "isSynchronised", "networkElements", "upgradeState" ], "properties": { "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "isSynchronised": { "type": "boolean", "description": " Identifies if the call to execute the script should wait until all scripts have been executed.True to wait, false otherwise.", "default": false }, "clientId": { "type": "string", "description": " Identifies the client Id that is requesting the execution(used for sending an event to the specific client when execution is complete)." }, "upgradeState": { "type": "integer", "description": " Identifies the SU Stage to perform." } }, "description": "Model containing the method level model for MMESoftwareFolderDescriptor.upgrade to decode json data to internal NFM-P object model" } } ], "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": "/restMediationOmniSoftwareFolderDescriptorUpgrade" }, "task": true }, { "name": "restMediationOmniSoftwareFolderDescriptorUpgradeFPGA", "summary": "rest_mediation_OmniSoftwareFolderDescriptor_upgradeFPGA", "description": "rest_mediation_OmniSoftwareFolderDescriptor_upgradeFPGA", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationOmniSoftwareFolderDescriptorUpgradeFPGA" }, "task": true }, { "name": "restMediationOmniSoftwareFolderDescriptorUpgradeUbootMiniBoot", "summary": "rest_mediation_OmniSoftwareFolderDescriptor_upgradeUbootMiniBoot", "description": "rest_mediation_OmniSoftwareFolderDescriptor_upgradeUbootMiniBoot", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationOmniSoftwareFolderDescriptorUpgradeUbootMiniBoot" }, "task": true }, { "name": "restMediationPSSSoftwareFolderDescriptorAbort", "summary": "rest_mediation_PSSSoftwareFolderDescriptor_abort", "description": "rest_mediation_PSSSoftwareFolderDescriptor_abort", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationPSSSoftwareFolderDescriptorAbort" }, "task": true }, { "name": "restMediationPSSSoftwareFolderDescriptorActivate", "summary": "rest_mediation_PSSSoftwareFolderDescriptor_activate", "description": "rest_mediation_PSSSoftwareFolderDescriptor_activate", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationPSSSoftwareFolderDescriptorActivate" }, "task": true }, { "name": "restMediationPSSSoftwareFolderDescriptorAudit", "summary": "rest_mediation_PSSSoftwareFolderDescriptor_audit", "description": "rest_mediation_PSSSoftwareFolderDescriptor_audit", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"networkElements\": \"array\", \"auditSettings\": 123}", "required": false, "schema": { "type": "object", "required": [ "auditSettings", "networkElements" ], "properties": { "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "auditSettings": { "type": "integer", "description": " This parameter will pickup the local audit settings details defining Default Audit Settings Force Upgrade Only Node Backup Only Both Force Upgrade and Node Backup None." } }, "description": "Model containing the method level model for OCSSoftwareFolderDescriptor.audit to decode json data to internal NFM-P object model" } } ], "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": "/restMediationPSSSoftwareFolderDescriptorAudit" }, "task": true }, { "name": "restMediationPSSSoftwareFolderDescriptorAutoUpgrade", "summary": "rest_mediation_PSSSoftwareFolderDescriptor_autoUpgrade", "description": "rest_mediation_PSSSoftwareFolderDescriptor_autoUpgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"networkElements\": \"array\", \"auditSettings\": 123, \"isConcurrent\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "auditSettings", "isConcurrent", "networkElements" ], "properties": { "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "auditSettings": { "type": "integer", "description": " This parameter will pickup the local audit settings details defining Default Audit Settings Force Upgrade Only Node Backup Only Both Force Upgrade and Node Backup None." }, "isConcurrent": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for OCSSoftwareFolderDescriptor.autoUpgrade to decode json data to internal NFM-P object model" } } ], "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": "/restMediationPSSSoftwareFolderDescriptorAutoUpgrade" }, "task": true }, { "name": "restMediationPSSSoftwareFolderDescriptorCommit", "summary": "rest_mediation_PSSSoftwareFolderDescriptor_commit", "description": "rest_mediation_PSSSoftwareFolderDescriptor_commit", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationPSSSoftwareFolderDescriptorCommit" }, "task": true }, { "name": "restMediationPSSSoftwareFolderDescriptorDownload", "summary": "rest_mediation_PSSSoftwareFolderDescriptor_download", "description": "rest_mediation_PSSSoftwareFolderDescriptor_download", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationPSSSoftwareFolderDescriptorDownload" }, "task": true }, { "name": "restMediationPSSSoftwareFolderDescriptorRevert", "summary": "rest_mediation_PSSSoftwareFolderDescriptor_revert", "description": "rest_mediation_PSSSoftwareFolderDescriptor_revert", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationPSSSoftwareFolderDescriptorRevert" }, "task": true }, { "name": "restMediationPSSSoftwareFolderDescriptorScheduleUpgrade", "summary": "rest_mediation_PSSSoftwareFolderDescriptor_scheduleUpgrade", "description": "rest_mediation_PSSSoftwareFolderDescriptor_scheduleUpgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"schedule\": \"string\", \"networkElements\": \"array\", \"isConcurrent\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "isConcurrent", "networkElements", "schedule" ], "properties": { "schedule": { "type": "string", "description": " " }, "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "isConcurrent": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for OCSSoftwareFolderDescriptor.scheduleUpgrade to decode json data to internal NFM-P object model" } } ], "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": "/restMediationPSSSoftwareFolderDescriptorScheduleUpgrade" }, "task": true }, { "name": "restMediationRANAldSoftwareFolderDescriptorAldUpgrade", "summary": "aldUpgrade", "description": "This operation results in transfer of the image set to the selected elements. Intention : MODIFIER aldUpgrade: instance-level modifier API aldUpgrade of class mediation.RANAldSoftwareFolderDescriptor instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aldElements\": \"array\", \"requestId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "aldElements", "requestId" ], "properties": { "aldElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "requestId": { "type": "string", "description": " " } }, "description": "Model containing the method level model for RANAldSoftwareFolderDescriptor.aldUpgrade to decode json data to internal NFM-P object model" } } ], "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": "/restMediationRANAldSoftwareFolderDescriptorAldUpgrade" }, "task": true }, { "name": "restMediationRANSoftwareFolderDescriptorAbort", "summary": "rest_mediation_RANSoftwareFolderDescriptor_abort", "description": "rest_mediation_RANSoftwareFolderDescriptor_abort", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationRANSoftwareFolderDescriptorAbort" }, "task": true }, { "name": "restMediationRANSoftwareFolderDescriptorAccept", "summary": "rest_mediation_RANSoftwareFolderDescriptor_accept", "description": "rest_mediation_RANSoftwareFolderDescriptor_accept", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationRANSoftwareFolderDescriptorAccept" }, "task": true }, { "name": "restMediationRANSoftwareFolderDescriptorActivate", "summary": "rest_mediation_RANSoftwareFolderDescriptor_activate", "description": "rest_mediation_RANSoftwareFolderDescriptor_activate", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationRANSoftwareFolderDescriptorActivate" }, "task": true }, { "name": "restMediationRANSoftwareFolderDescriptorDownload", "summary": "rest_mediation_RANSoftwareFolderDescriptor_download", "description": "rest_mediation_RANSoftwareFolderDescriptor_download", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"networkElements\": \"array\", \"requestId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "networkElements", "requestId" ], "properties": { "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "requestId": { "type": "string", "description": " " } }, "description": "Model containing the method level model for RANSoftwareFolderDescriptor.download to decode json data to internal NFM-P object model" } } ], "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": "/restMediationRANSoftwareFolderDescriptorDownload" }, "task": true }, { "name": "restMediationRANSoftwareFolderDescriptorReject", "summary": "rest_mediation_RANSoftwareFolderDescriptor_reject", "description": "rest_mediation_RANSoftwareFolderDescriptor_reject", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationRANSoftwareFolderDescriptorReject" }, "task": true }, { "name": "restMediationRANSoftwareFolderDescriptorScheduleActivate", "summary": "rest_mediation_RANSoftwareFolderDescriptor_scheduleActivate", "description": "rest_mediation_RANSoftwareFolderDescriptor_scheduleActivate", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"schedule\": \"string\", \"networkElements\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "networkElements", "schedule" ], "properties": { "schedule": { "type": "string", "description": " " }, "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for RANSoftwareFolderDescriptor.scheduleActivate to decode json data to internal NFM-P object model" } } ], "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": "/restMediationRANSoftwareFolderDescriptorScheduleActivate" }, "task": true }, { "name": "restMediationRANSoftwareFolderDescriptorScheduleUpgrade", "summary": "rest_mediation_RANSoftwareFolderDescriptor_scheduleUpgrade", "description": "rest_mediation_RANSoftwareFolderDescriptor_scheduleUpgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"schedule\": \"string\", \"networkElements\": \"array\", \"isConcurrent\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "isConcurrent", "networkElements", "schedule" ], "properties": { "schedule": { "type": "string", "description": " " }, "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "isConcurrent": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for OCSSoftwareFolderDescriptor.scheduleUpgrade to decode json data to internal NFM-P object model" } } ], "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": "/restMediationRANSoftwareFolderDescriptorScheduleUpgrade" }, "task": true }, { "name": "restMediationRANSoftwareFolderDescriptorStopMonitoring", "summary": "rest_mediation_RANSoftwareFolderDescriptor_stopMonitoring", "description": "rest_mediation_RANSoftwareFolderDescriptor_stopMonitoring", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationRANSoftwareFolderDescriptorStopMonitoring" }, "task": true }, { "name": "restMediationSoftwareFolderDescriptorActivateImage", "summary": "rest_mediation_SoftwareFolderDescriptor_activateImage", "description": "rest_mediation_SoftwareFolderDescriptor_activateImage", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationSoftwareFolderDescriptorActivateImage" }, "task": true }, { "name": "restMediationSoftwareFolderDescriptorExtShelfScheduleUpgrade", "summary": "rest_mediation_SoftwareFolderDescriptor_extShelfScheduleUpgrade", "description": "rest_mediation_SoftwareFolderDescriptor_extShelfScheduleUpgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"schedule\": \"string\", \"extShelves\": [{\"objectClassName\": \"string\", \"objectFullName\": \"string\", \"allomorphicClassName\": \"string\", \"objectId\": 123, \"displayedName\": \"string\", \"lifeCycleState\": \"string\", \"deploymentState\": \"string\", \"neId\": \"string\", \"spanObjectPointer\": \"string\", \"parentClassName\": \"string\", \"managedObjectId\": 123, \"unsetProperties\": \"array\", \"containmentInfo\": \"object\", \"affectedObjects\": \"object\", \"affectingObjects\": \"object\", \"siteId\": \"string\", \"shelfId\": 123, \"oesShelfId\": 123, \"phyShelfClass\": 123, \"policyType\": 123, \"softwareUpgradePolicyId\": 123, \"scheduleType\": 123, \"softwareImage\": \"string\", \"softwareRepository\": \"string\", \"id\": 123, \"description\": \"string\"}]}", "required": false, "schema": { "type": "object", "required": [ "extShelves", "schedule" ], "properties": { "schedule": { "type": "string", "description": " " }, "extShelves": { "type": "array", "description": " ", "items": { "type": "object", "required": [ "affectedObjects", "affectingObjects", "allomorphicClassName", "containmentInfo", "deploymentState", "displayedName", "lifeCycleState", "managedObjectId", "neId", "objectClassName", "objectFullName", "objectId", "parentClassName", "spanObjectPointer", "unsetProperties" ], "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer" }, "unsetProperties": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "allomorphicClassName", "deploymentState", "displayedName", "lifeCycleState", "managedObjectId", "neId", "objectClassName", "objectFullName", "objectId", "parentClassName", "spanObjectPointer", "unsetProperties" ], "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer" }, "unsetProperties": { "type": "array", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "siteId": { "type": "string" }, "shelfId": { "type": "integer" }, "oesShelfId": { "type": "integer" }, "phyShelfClass": { "type": "integer" }, "policyType": { "type": "integer" }, "softwareUpgradePolicyId": { "type": "integer" }, "scheduleType": { "type": "integer" }, "softwareImage": { "type": "string" }, "softwareRepository": { "type": "string" }, "id": { "type": "integer" }, "description": { "type": "string" } }, "description": "Model containing the method level model for Interface ExtensionShelfUpgradeManagerInfo. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for SoftwareFolderDescriptor.extShelfScheduleUpgrade to decode json data to internal NFM-P object model" } } ], "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": "/restMediationSoftwareFolderDescriptorExtShelfScheduleUpgrade" }, "task": true }, { "name": "restMediationSoftwareFolderDescriptorFindApplicableNes", "summary": "findApplicableNes", "description": "Used to find list network elements that could be upgraded using this image. Intention : RETRIEVER findApplicableNes: instance-level [object finder] (retriever) API findApplicableNes of class mediation.SoftwareFolderDescriptor instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "isScheduled", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "isScheduled", "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": "/restMediationSoftwareFolderDescriptorFindApplicableNes" }, "task": true }, { "name": "restMediationSoftwareFolderDescriptorScheduleUpgrade", "summary": "rest_mediation_SoftwareFolderDescriptor_scheduleUpgrade", "description": "rest_mediation_SoftwareFolderDescriptor_scheduleUpgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"schedule\": \"string\", \"networkElements\": \"array\", \"isConcurrent\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "isConcurrent", "networkElements", "schedule" ], "properties": { "schedule": { "type": "string", "description": " " }, "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "isConcurrent": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for OCSSoftwareFolderDescriptor.scheduleUpgrade to decode json data to internal NFM-P object model" } } ], "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": "/restMediationSoftwareFolderDescriptorScheduleUpgrade" }, "task": true }, { "name": "restMediationSoftwareFolderDescriptorUpgrade", "summary": "rest_mediation_SoftwareFolderDescriptor_upgrade", "description": "rest_mediation_SoftwareFolderDescriptor_upgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationSoftwareFolderDescriptorUpgrade" }, "task": true }, { "name": "restMediationSoftwareFolderDescriptorUpgradeExtShelves", "summary": "upgradeExtShelves", "description": "This operation results in transfer of the image set, to the selected Extended Shelves on SR Chassis, as per assigned,\nsoftware upgrade policy, followed by activation of the image (reboot or reboot with firmware upgrade).\n\ninstance-level modifier API upgradeExtShelves of class mediation.SoftwareFolderDescriptor\n\n\n\nFor example, the client makes the following HTTP request:\n\n POST: v2/mediation/SoftwareFolderDescriptor/upgradeExtShelves/TiMOS-B-20.9.R1\n Host: server.example.com\n Au...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationSoftwareFolderDescriptorUpgradeExtShelves" }, "task": true }, { "name": "restMediationSoftwareFolderDescriptorValidateDiskSpace", "summary": "rest_mediation_SoftwareFolderDescriptor_validateDiskSpace", "description": "rest_mediation_SoftwareFolderDescriptor_validateDiskSpace", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationSoftwareFolderDescriptorValidateDiskSpace" }, "task": true }, { "name": "restMediationSoftwareFolderManagerGetInfo", "summary": "getInfo", "description": "Intention : ACCESSOR getInfo: instance-level accessor API getInfo on default instance network:SoftwareFolderManager of class mediation.SoftwareFolderManager", "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": "/restMediationSoftwareFolderManagerGetInfo" }, "task": true }, { "name": "restMediationSoftwareFolderManagerImportFwImage", "summary": "importFwImage", "description": "This operation reads the firmware image files, from a selected location, relative to the local directory server_install_dir nms nodeSoftware and saves them in the NFM-P database. The local directory server_install_dir nms nodeSoftware shall be cleaned up periodically, based on config parameter - \"nodeSoftware timeToKeepFile\" (default = 1440 minutes), specified in nms-server.xml config file. Intention : MODIFIER importFwImage: instance-level modifier API importFwImage on default instance n...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"imageFileNames\": \"array\", \"imageLocation\": \"string\", \"shelfType\": 123, \"firmwareVersion\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "firmwareVersion", "imageFileNames", "imageLocation", "shelfType" ], "properties": { "imageFileNames": { "type": "array", "description": " List of file names to be imported. If empty, all the files in the directory referred to by \"imageLocation\" parametershall be picked up.", "items": { "type": "string" } }, "imageLocation": { "type": "string", "description": " Relative name of the directory containing all the image files (relative to the local directory server_install_dir nms nodeSoftware )." }, "shelfType": { "type": "integer", "description": " shelfType - for SAR-Hm it is 413 and SAR-Hmc it is 515" }, "firmwareVersion": { "type": "string", "description": " firmware version" } }, "description": "Model containing the method level model for SoftwareFolderManager.importFwImage to decode json data to internal NFM-P object model" } } ], "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": "/restMediationSoftwareFolderManagerImportFwImage" }, "task": true }, { "name": "restMediationSoftwareFolderManagerImportImage", "summary": "importImage", "description": "This operation reads the software image files, from a selected location, relative to the local directory server_install_dir nms nodeSoftware and saves them in the NFM-P database. The local directory server_install_dir nms nodeSoftware shall be cleaned up periodically, based on config parameter - \"nodeSoftware timeToKeepFile\" (default = 1440 minutes), specified in nms-server.xml config file. Example (eNodeB): <mediation.SoftwareFolderManager.importImage xmlns=\"xmlapi_1.0\"> <...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"imageFileNames\": \"array\", \"imageLocation\": \"string\", \"imageType\": \"string\", \"md5Map\": \"object\", \"versionString\": \"string\", \"gneType\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "gneType", "imageFileNames", "imageLocation", "imageType", "md5Map", "versionString" ], "properties": { "imageFileNames": { "type": "array", "description": " List of file names to be imported. If empty, all the files in the directory referred to by \"imageLocation\" parametershall be picked up.{blockquote}{pre}Example 1:<imageFileNames> <string>myfile.ext< string>< imageFileNames>{BR}Example 2:<imageFileNames> <string>myfile1.ext< string> <string>myfile2.ext< string> <string>myfile3.ext< string>< imageFileNames>{ pre}{ blockquote}", "items": { "type": "string" } }, "imageLocation": { "type": "string", "description": " Relative name of the directory containing all the image files (relative to the local directory server_install_dir nms nodeSoftware ).Descriptor file must be included for RAN based images." }, "imageType": { "type": "string", "description": " Type of image - srBased, aosBased, mprBased, mmeBased, etc." }, "md5Map": { "type": "object", "description": " Map of file names and their md5 checksums. Used for validation, if not empty.{blockquote}{pre}Example:<md5Map> <item> <key>myfile.ext< key> <value>123456789< value> < item>< md5Map>{ pre}{ blockquote}", "additionalProperties": { "type": "string" } }, "versionString": { "type": "string", "description": " Image version." }, "gneType": { "type": "string", "description": " Used for generic nodes, this parameter contains the Generic Ne Profile fullname, used to determine GNE types that can be upgraded, using this image." } }, "description": "Model containing the method level model for SoftwareFolderManager.importImage to decode json data to internal NFM-P object model" } } ], "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": "/restMediationSoftwareFolderManagerImportImage" }, "task": true }, { "name": "restMediationVwmOsuSoftwareFolderDescriptorAbort", "summary": "rest_mediation_VwmOsuSoftwareFolderDescriptor_abort", "description": "rest_mediation_VwmOsuSoftwareFolderDescriptor_abort", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationVwmOsuSoftwareFolderDescriptorAbort" }, "task": true }, { "name": "restMediationVwmOsuSoftwareFolderDescriptorActivate", "summary": "rest_mediation_VwmOsuSoftwareFolderDescriptor_activate", "description": "rest_mediation_VwmOsuSoftwareFolderDescriptor_activate", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationVwmOsuSoftwareFolderDescriptorActivate" }, "task": true }, { "name": "restMediationVwmOsuSoftwareFolderDescriptorAudit", "summary": "rest_mediation_VwmOsuSoftwareFolderDescriptor_audit", "description": "rest_mediation_VwmOsuSoftwareFolderDescriptor_audit", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"networkElements\": \"array\", \"auditSettings\": 123}", "required": false, "schema": { "type": "object", "required": [ "auditSettings", "networkElements" ], "properties": { "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "auditSettings": { "type": "integer", "description": " This parameter will pickup the local audit settings details defining Default Audit Settings Force Upgrade Only Node Backup Only Both Force Upgrade and Node Backup None." } }, "description": "Model containing the method level model for OCSSoftwareFolderDescriptor.audit to decode json data to internal NFM-P object model" } } ], "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": "/restMediationVwmOsuSoftwareFolderDescriptorAudit" }, "task": true }, { "name": "restMediationVwmOsuSoftwareFolderDescriptorAutoUpgrade", "summary": "rest_mediation_VwmOsuSoftwareFolderDescriptor_autoUpgrade", "description": "rest_mediation_VwmOsuSoftwareFolderDescriptor_autoUpgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"networkElements\": \"array\", \"auditSettings\": 123, \"isConcurrent\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "auditSettings", "isConcurrent", "networkElements" ], "properties": { "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "auditSettings": { "type": "integer", "description": " This parameter will pickup the local audit settings details defining Default Audit Settings Force Upgrade Only Node Backup Only Both Force Upgrade and Node Backup None." }, "isConcurrent": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for OCSSoftwareFolderDescriptor.autoUpgrade to decode json data to internal NFM-P object model" } } ], "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": "/restMediationVwmOsuSoftwareFolderDescriptorAutoUpgrade" }, "task": true }, { "name": "restMediationVwmOsuSoftwareFolderDescriptorCommit", "summary": "rest_mediation_VwmOsuSoftwareFolderDescriptor_commit", "description": "rest_mediation_VwmOsuSoftwareFolderDescriptor_commit", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationVwmOsuSoftwareFolderDescriptorCommit" }, "task": true }, { "name": "restMediationVwmOsuSoftwareFolderDescriptorDownload", "summary": "rest_mediation_VwmOsuSoftwareFolderDescriptor_download", "description": "rest_mediation_VwmOsuSoftwareFolderDescriptor_download", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationVwmOsuSoftwareFolderDescriptorDownload" }, "task": true }, { "name": "restMediationVwmOsuSoftwareFolderDescriptorRevert", "summary": "rest_mediation_VwmOsuSoftwareFolderDescriptor_revert", "description": "rest_mediation_VwmOsuSoftwareFolderDescriptor_revert", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMediationVwmOsuSoftwareFolderDescriptorRevert" }, "task": true }, { "name": "restMediationVwmOsuSoftwareFolderDescriptorScheduleUpgrade", "summary": "rest_mediation_VwmOsuSoftwareFolderDescriptor_scheduleUpgrade", "description": "rest_mediation_VwmOsuSoftwareFolderDescriptor_scheduleUpgrade", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"schedule\": \"string\", \"networkElements\": \"array\", \"isConcurrent\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "isConcurrent", "networkElements", "schedule" ], "properties": { "schedule": { "type": "string", "description": " " }, "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "isConcurrent": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for OCSSoftwareFolderDescriptor.scheduleUpgrade to decode json data to internal NFM-P object model" } } ], "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": "/restMediationVwmOsuSoftwareFolderDescriptorScheduleUpgrade" }, "task": true }, { "name": "restMirrorPcapSessionShutDown", "summary": "rest_mirror_PcapSession_shutDown", "description": "rest_mirror_PcapSession_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMirrorPcapSessionShutDown" }, "task": true }, { "name": "restMirrorPcapSessionTurnUp", "summary": "rest_mirror_PcapSession_turnUp", "description": "rest_mirror_PcapSession_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMirrorPcapSessionTurnUp" }, "task": true }, { "name": "restMirrorliLICfgSaveLIConfig", "summary": "rest_mirrorli_LICfg_saveLIConfig", "description": "rest_mirrorli_LICfg_saveLIConfig", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restMirrorliLICfgSaveLIConfig" }, "task": true }, { "name": "restMldGroupInterfaceSapGroupRetrieveMldGroupIfSapGrp", "summary": "retrieveMldGroupIfSapGrp", "description": "Method used to query the NE for group address entries under a GroupInterfaceSap. Intention : RETRIEVER retrieveMldGroupIfSapGrp: class-level retriever API retrieveMldGroupIfSapGrp of class mld.GroupInterfaceSapGroup", "input": [ { "name": "body", "type": "object", "info": ": {\"aInGrpIfSapFdn\": \"string\", \"aInMldSapParams\": {\"objectClassName\": \"string\", \"encapType\": \"string\", \"siteId\": \"string\", \"svcId\": 123, \"fwdSvcId\": 123, \"grpIfIndex\": 123, \"portName\": \"string\", \"combinedEncap\": 123, \"innerEncapVal\": 123, \"outerEncapVal\": 123}}", "required": false, "schema": { "type": "object", "properties": { "aInGrpIfSapFdn": { "type": "string" }, "aInMldSapParams": { "type": "object", "required": [ "combinedEncap", "encapType", "fwdSvcId", "grpIfIndex", "innerEncapVal", "objectClassName", "outerEncapVal", "portName", "siteId", "svcId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "encapType": { "type": "string" }, "siteId": { "type": "string" }, "svcId": { "type": "integer" }, "fwdSvcId": { "type": "integer" }, "grpIfIndex": { "type": "integer" }, "portName": { "type": "string" }, "combinedEncap": { "type": "integer" }, "innerEncapVal": { "type": "integer" }, "outerEncapVal": { "type": "integer" } }, "description": "Model containing the method level model for struct MldSapStruct. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for GroupInterfaceSapGroup.retrieveMldGroupIfSapGrp to decode json data to internal NFM-P object model" } } ], "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": "/restMldGroupInterfaceSapGroupRetrieveMldGroupIfSapGrp" }, "task": true }, { "name": "restMldMldHostRetrieveMldHostPerSubscrHost", "summary": "retrieveMldHostPerSubscrHost", "description": "Method used to retrieve MLD Host which is mapped to Subscriber Host from Residential Subscriber Host window. Intention : RETRIEVER retrieveMldHostPerSubscrHost: class-level retriever API retrieveMldHostPerSubscrHost of class mld.MldHost", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"ipAddressType\": \"string\", \"siteId\": \"string\", \"routerId\": 123, \"ipAddress\": \"string\", \"macAddress\": \"string\", \"sessionId\": 123, \"serviceId\": 123}", "required": false, "schema": { "type": "object", "required": [ "ipAddress", "ipAddressType", "macAddress", "objectClassName", "routerId", "serviceId", "sessionId", "siteId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "ipAddressType": { "type": "string" }, "siteId": { "type": "string" }, "routerId": { "type": "integer" }, "ipAddress": { "type": "string" }, "macAddress": { "type": "string" }, "sessionId": { "type": "integer" }, "serviceId": { "type": "integer" } }, "description": "Model containing the method level model for struct MldHostBaseInfoStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restMldMldHostRetrieveMldHostPerSubscrHost" }, "task": true }, { "name": "restMldMldHostRetrieveMldHosts", "summary": "retrieveMldHosts", "description": "Method used to query the NE for MLD host and child objects (MLD Groups) associated with a subscriber. Intention : RETRIEVER retrieveMldHosts: class-level retriever API retrieveMldHosts of class mld.MldHost", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInSubId\": \"string\", \"aInMCacPolicyPointer\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInSubId": { "type": "string" }, "aInMCacPolicyPointer": { "type": "string" } }, "description": "Model containing the method level model for MldHost.retrieveMldHosts to decode json data to internal NFM-P object model" } } ], "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": "/restMldMldHostRetrieveMldHosts" }, "task": true }, { "name": "restMldMldHostRetrieveResSubscrMldHosts", "summary": "retrieveResSubscrMldHosts", "description": "Method used to query the NE for MLD hosts and child objects (MLD Groups and Sources) from Residential Subscriber Manager window Intention : RETRIEVER retrieveResSubscrMldHosts: class-level retriever API retrieveResSubscrMldHosts of class mld.MldHost", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"routerId\": 123, \"serviceId\": 123, \"grpIfIndex\": 123, \"includeChildren\": \"boolean\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "grpIfIndex", "includeChildren", "objectClassName", "routerId", "serviceId", "siteId", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "routerId": { "type": "integer" }, "serviceId": { "type": "integer" }, "grpIfIndex": { "type": "integer" }, "includeChildren": { "type": "boolean", "default": false }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct MldHostRetrievalStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restMldMldHostRetrieveResSubscrMldHosts" }, "task": true }, { "name": "restMonpathBidirMonitoredIpPathCaptureCurrentPath", "summary": "rest_monpath_BidirMonitoredIpPath_captureCurrentPath", "description": "rest_monpath_BidirMonitoredIpPath_captureCurrentPath", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMonpathBidirMonitoredIpPathCaptureCurrentPath" }, "task": true }, { "name": "restMonpathBidirMonitoredLspPathCaptureCurrentPath", "summary": "rest_monpath_BidirMonitoredLspPath_captureCurrentPath", "description": "rest_monpath_BidirMonitoredLspPath_captureCurrentPath", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMonpathBidirMonitoredLspPathCaptureCurrentPath" }, "task": true }, { "name": "restMonpathMonitoredIpPathCaptureCurrentPath", "summary": "rest_monpath_MonitoredIpPath_captureCurrentPath", "description": "rest_monpath_MonitoredIpPath_captureCurrentPath", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMonpathMonitoredIpPathCaptureCurrentPath" }, "task": true }, { "name": "restMonpathMonitoredIpPathFindServices", "summary": "findServices", "description": "Find all the associated Services with an IP path monitor. Intention : RETRIEVER findServices: instance-level [object finder] (retriever) API findServices of class monpath.MonitoredIpPath instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectType\": 123, \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "fields", "filter", "objectType", "pageNumber", "pageSize", "sortFields" ], "properties": { "objectType": { "type": "integer", "description": " " }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "fields": { "type": "array", "description": " Sorting fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for IpPathRecord.findServices to decode json data to internal NFM-P object model" } } ], "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": "/restMonpathMonitoredIpPathFindServices" }, "task": true }, { "name": "restMonpathMonitoredLspPathCaptureCurrentPath", "summary": "rest_monpath_MonitoredLspPath_captureCurrentPath", "description": "rest_monpath_MonitoredLspPath_captureCurrentPath", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMonpathMonitoredLspPathCaptureCurrentPath" }, "task": true }, { "name": "restMonpathMonitoredLspPathFindServices", "summary": "findServices", "description": "Find all the associated Services with an IP path monitor. Intention : RETRIEVER findServices: instance-level [object finder] (retriever) API findServices of class monpath.MonitoredLspPath instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectType\": 123, \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "fields", "filter", "objectType", "pageNumber", "pageSize", "sortFields" ], "properties": { "objectType": { "type": "integer", "description": " " }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "fields": { "type": "array", "description": " Sorting fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for IpPathRecord.findServices to decode json data to internal NFM-P object model" } } ], "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": "/restMonpathMonitoredLspPathFindServices" }, "task": true }, { "name": "restMonpathMonitoredP2MPLspPathCaptureCurrentPath", "summary": "rest_monpath_MonitoredP2MPLspPath_captureCurrentPath", "description": "rest_monpath_MonitoredP2MPLspPath_captureCurrentPath", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMonpathMonitoredP2MPLspPathCaptureCurrentPath" }, "task": true }, { "name": "restMonpathMonitoredP2MPLspPathFindServices", "summary": "findServices", "description": "Find all the associated Services with a P2MP LSP path monitor. Intention : RETRIEVER findServices: instance-level [object finder] (retriever) API findServices of class monpath.MonitoredP2MPLspPath instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectType\": 123, \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "fields", "filter", "objectType", "pageNumber", "pageSize", "sortFields" ], "properties": { "objectType": { "type": "integer", "description": " " }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "fields": { "type": "array", "description": " Sorting fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for IpPathRecord.findServices to decode json data to internal NFM-P object model" } } ], "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": "/restMonpathMonitoredP2MPLspPathFindServices" }, "task": true }, { "name": "restMonpathMonitoredPathValidatePath", "summary": "validatePath", "description": "Used to trigger the execution of the OAM tests on this monitored path. Intention : RETRIEVER validatePath: instance-level retriever API validatePath of class monpath.MonitoredPath DescendantInfo: monpath.UnidirMonitoredPath DescendantInfo: monpath.BidirMonitoredLspPath DescendantInfo: monpath.MonitoredLspPath DescendantInfo: monpath.MonitoredIpPath DescendantInfo: monpath.BidirMonitoredIpPath DescendantInfo: monpath.MonitoredP2MPLspPath DescendantInfo: monpath.MonitoredS2LPath...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMonpathMonitoredPathValidatePath" }, "task": true }, { "name": "restMonpathMonitoredPathValidatePaths", "summary": "validatePaths", "description": "Used to trigger the execution of the OAM tests on multiple monitored paths. Intention : RETRIEVER validatePaths: class-level retriever API validatePaths of class monpath.MonitoredPath DescendantInfo: monpath.UnidirMonitoredPath DescendantInfo: monpath.BidirMonitoredLspPath DescendantInfo: monpath.MonitoredLspPath DescendantInfo: monpath.MonitoredIpPath DescendantInfo: monpath.BidirMonitoredIpPath DescendantInfo: monpath.MonitoredP2MPLspPath DescendantInfo: monpath.MonitoredS2L...(description truncated)", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMonpathMonitoredPathValidatePaths" }, "task": true }, { "name": "restMonpathMonitoredPathManagerCreateBidirMonitoredPath", "summary": "createBidirMonitoredPath", "description": "Used to create multiple birdir lsp monitored paths from the passed in LSPs. Intention : MODIFIER createBidirMonitoredPath: class-level [administrative creation] (modifier) API createBidirMonitoredPath on default instance monitored-path-mgr of class monpath.MonitoredPathManager", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMonpathMonitoredPathManagerCreateBidirMonitoredPath" }, "task": true }, { "name": "restMonpathMonitoredPathManagerCreateMonitoredPath", "summary": "rest_monpath_MonitoredPathManager_createMonitoredPath", "description": "rest_monpath_MonitoredPathManager_createMonitoredPath", "input": [ { "name": "body", "type": "object", "info": ": {\"sourceObjectNameSet\": \"array\", \"isBidirectional\": \"boolean\", \"pathType\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "isBidirectional", "pathType", "sourceObjectNameSet" ], "properties": { "sourceObjectNameSet": { "type": "array", "description": " The full name of the objects to create monitored paths from.", "uniqueItems": true, "items": { "type": "string" } }, "isBidirectional": { "type": "boolean", "description": " Whether to create bidirectional monitored paths or not.If true, all objects for which bidirectional paths cannot be created will be ignored.", "default": false }, "pathType": { "type": "array", "description": " The LSP path types that are monitored on a LSP path monitor.Only applicable for LSP path monitors, ignored otherwise.", "items": { "type": "string" } } }, "description": "Model containing the method level model for MonitoredPathManager.createMonitoredPath to decode json data to internal NFM-P object model" } } ], "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": "/restMonpathMonitoredPathManagerCreateMonitoredPath" }, "task": true }, { "name": "restMonpathMonitoredS2LPathCaptureCurrentPath", "summary": "rest_monpath_MonitoredS2LPath_captureCurrentPath", "description": "rest_monpath_MonitoredS2LPath_captureCurrentPath", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMonpathMonitoredS2LPathCaptureCurrentPath" }, "task": true }, { "name": "restMonpathMonitoredS2LPathFindServices", "summary": "findServices", "description": "Find all the associated Services with a P2MP S2L Path monitor. Intention : RETRIEVER findServices: instance-level [object finder] (retriever) API findServices of class monpath.MonitoredS2LPath instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectType\": 123, \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "fields", "filter", "objectType", "pageNumber", "pageSize", "sortFields" ], "properties": { "objectType": { "type": "integer", "description": " " }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "fields": { "type": "array", "description": " Sorting fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for IpPathRecord.findServices to decode json data to internal NFM-P object model" } } ], "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": "/restMonpathMonitoredS2LPathFindServices" }, "task": true }, { "name": "restMplsCrossconnectConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: class-level [hierarchical administrative configuration/modification] (modifier) API configure of class mpls.Crossconnect This API follows hierarchical config model rules.", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"routerIdOrZero\": 123, \"configInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}}", "required": false, "schema": { "type": "object", "required": [ "configInfo", "routerIdOrZero", "siteId" ], "properties": { "siteId": { "type": "string", "description": " " }, "routerIdOrZero": { "type": "integer", "description": " " }, "configInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for Crossconnect.configure to decode json data to internal NFM-P object model" } } ], "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": "/restMplsCrossconnectConfigure" }, "task": true }, { "name": "restMplsDynamicLspFindCrossconnects", "summary": "findCrossconnects", "description": "method to retrieve all crossconnects associated with this LSP, including detour bypass tunnels created crossconnects Intention : RETRIEVER findCrossconnects: instance-level [object finder] (retriever) API findCrossconnects of class mpls.DynamicLsp instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsDynamicLspFindCrossconnects" }, "task": true }, { "name": "restMplsDynamicLspFindRsvpSessions", "summary": "findRsvpSessions", "description": "Intention : RETRIEVER findRsvpSessions: instance-level [object finder] (retriever) API findRsvpSessions of class mpls.DynamicLsp instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsDynamicLspFindRsvpSessions" }, "task": true }, { "name": "restMplsHopFindInterface", "summary": "findInterface", "description": "Intention : RETRIEVER findInterface: instance-level [object finder] (retriever) API findInterface of class mpls.Hop DescendantInfo: mpls.CSPFHop DescendantInfo: mpls.ProvisionedHop DescendantInfo: mpls.ActualHop instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMplsHopFindInterface" }, "task": true }, { "name": "restMplsHopFindPort", "summary": "findPort", "description": "Intention : RETRIEVER findPort: instance-level [object finder] (retriever) API findPort of class mpls.Hop DescendantInfo: mpls.CSPFHop DescendantInfo: mpls.ProvisionedHop DescendantInfo: mpls.ActualHop instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMplsHopFindPort" }, "task": true }, { "name": "restMplsIngStatsPolicyShutDown", "summary": "rest_mpls_IngStatsPolicy_shutDown", "description": "rest_mpls_IngStatsPolicy_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMplsIngStatsPolicyShutDown" }, "task": true }, { "name": "restMplsIngStatsPolicyTurnUp", "summary": "rest_mpls_IngStatsPolicy_turnUp", "description": "rest_mpls_IngStatsPolicy_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMplsIngStatsPolicyTurnUp" }, "task": true }, { "name": "restMplsInterfaceConfigure", "summary": "rest_mpls_Interface_configure", "description": "rest_mpls_Interface_configure", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restMplsInterfaceConfigure" }, "task": true }, { "name": "restMplsLspFindLdpTargetedPeers", "summary": "findLdpTargetedPeers", "description": "Intention : RETRIEVER findLdpTargetedPeers: instance-level [object finder] (retriever) API findLdpTargetedPeers of class mpls.Lsp DescendantInfo: mpls.DynamicLsp DescendantInfo: mpls.BypassOnlyLsp DescendantInfo: mpls.StaticLsp DescendantInfo: mpls.SegmentRoutingTeLsp instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsLspFindLdpTargetedPeers" }, "task": true }, { "name": "restMplsLspFindServiceCircuits", "summary": "findServiceCircuits", "description": "Intention : RETRIEVER findServiceCircuits: instance-level [object finder] (retriever) API findServiceCircuits of class mpls.Lsp DescendantInfo: mpls.DynamicLsp DescendantInfo: mpls.BypassOnlyLsp DescendantInfo: mpls.StaticLsp DescendantInfo: mpls.SegmentRoutingTeLsp instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsLspFindServiceCircuits" }, "task": true }, { "name": "restMplsLspFindServicePaths", "summary": "findServicePaths", "description": "Intention : RETRIEVER findServicePaths: instance-level [object finder] (retriever) API findServicePaths of class mpls.Lsp DescendantInfo: mpls.DynamicLsp DescendantInfo: mpls.BypassOnlyLsp DescendantInfo: mpls.StaticLsp DescendantInfo: mpls.SegmentRoutingTeLsp instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsLspFindServicePaths" }, "task": true }, { "name": "restMplsLspFindServices", "summary": "findServices", "description": "Intention : RETRIEVER findServices: instance-level [object finder] (retriever) API findServices of class mpls.Lsp DescendantInfo: mpls.DynamicLsp DescendantInfo: mpls.BypassOnlyLsp DescendantInfo: mpls.StaticLsp DescendantInfo: mpls.SegmentRoutingTeLsp instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsLspFindServices" }, "task": true }, { "name": "restMplsLspFindSubscribers", "summary": "findSubscribers", "description": "Intention : RETRIEVER findSubscribers: instance-level [object finder] (retriever) API findSubscribers of class mpls.Lsp DescendantInfo: mpls.DynamicLsp DescendantInfo: mpls.BypassOnlyLsp DescendantInfo: mpls.StaticLsp DescendantInfo: mpls.SegmentRoutingTeLsp instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsLspFindSubscribers" }, "task": true }, { "name": "restMplsLspPathOptimizationPolicyExecute", "summary": "execute", "description": "Find LSP Path identified by the filter and inner Join Condition to DynamicLSP and Rule-Based Group Binding and then flag them if possible. Execute resignal of eligible and flagged lspPaths in accordance to this policy. Intention : MODIFIER execute: instance-level modifier API execute of class mpls.LspPathOptimizationPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsLspPathOptimizationPolicyExecute" }, "task": true }, { "name": "restMplsLspPathOptimizationPolicyExecuteFromList", "summary": "executeFromList", "description": "Find LSP Path identified by the filter and inner Join Condition to DynamicLSP and Rule-Based Group Binding and then flag them if possible. Execute resignal of eligible and flagged lspPaths in accordance to this policy. Intention : MODIFIER executeFromList: instance-level modifier API executeFromList of class mpls.LspPathOptimizationPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMplsLspPathOptimizationPolicyExecuteFromList" }, "task": true }, { "name": "restMplsLspPathOptimizationPolicyFindPathWithJoin", "summary": "findPathWithJoin", "description": "Find LSP Path identified by the filter and inner Join Condition to DynamicLSP and MPLS.Tunnel. Intention : RETRIEVER findPathWithJoin: instance-level [object finder] (retriever) API findPathWithJoin of class mpls.LspPathOptimizationPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "fields", "filter", "pageNumber", "pageSize", "sortFields" ], "properties": { "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "fields": { "type": "array", "description": " Fields to fetch", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for LspPathOptimizationPolicy.findPathWithJoin to decode json data to internal NFM-P object model" } } ], "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": "/restMplsLspPathOptimizationPolicyFindPathWithJoin" }, "task": true }, { "name": "restMplsLspPathOptimizationPolicyTerminateCurrentExecution", "summary": "rest_mpls_LspPathOptimizationPolicy_terminateCurrentExecution", "description": "rest_mpls_LspPathOptimizationPolicy_terminateCurrentExecution", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMplsLspPathOptimizationPolicyTerminateCurrentExecution" }, "task": true }, { "name": "restMplsLspTemplateMvpnFindP2mpLsp", "summary": "findP2mpLsp", "description": "Intention : RETRIEVER findP2mpLsp: instance-level [object finder] (retriever) API findP2mpLsp of class mpls.LspTemplateMvpn instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsLspTemplateMvpnFindP2mpLsp" }, "task": true }, { "name": "restMplsLspTemplateMvpnFindP2pLsp", "summary": "findP2pLsp", "description": "Intention : RETRIEVER findP2pLsp: instance-level [object finder] (retriever) API findP2pLsp of class mpls.LspTemplateMvpn instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsLspTemplateMvpnFindP2pLsp" }, "task": true }, { "name": "restMplsP2MPDynamicLspFindCrossconnects", "summary": "findCrossconnects", "description": "method to retrieve all crossconnects associated with this LSP, including bypass tunnels created crossconnects Intention : RETRIEVER findCrossconnects: instance-level [object finder] (retriever) API findCrossconnects of class mpls.P2MPDynamicLsp instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsP2MPDynamicLspFindCrossconnects" }, "task": true }, { "name": "restMplsP2MPDynamicLspFindRsvpSessions", "summary": "findRsvpSessions", "description": "Intention : RETRIEVER findRsvpSessions: instance-level [object finder] (retriever) API findRsvpSessions of class mpls.P2MPDynamicLsp instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsP2MPDynamicLspFindRsvpSessions" }, "task": true }, { "name": "restMplsPolicyFindAdminGroups", "summary": "findAdminGroups", "description": "Intention : RETRIEVER findAdminGroups: class-level [object finder] (retriever) API findAdminGroups of class mpls.Policy", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsPolicyFindAdminGroups" }, "task": true }, { "name": "restMplsPolicyFindInterfaces", "summary": "findInterfaces", "description": "Intention : RETRIEVER findInterfaces: instance-level [object finder] (retriever) API findInterfaces of class mpls.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsPolicyFindInterfaces" }, "task": true }, { "name": "restMplsPolicyFindLspPaths", "summary": "findLspPaths", "description": "Intention : RETRIEVER findLspPaths: instance-level [object finder] (retriever) API findLspPaths of class mpls.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsPolicyFindLspPaths" }, "task": true }, { "name": "restMplsPolicyFindLsps", "summary": "findLsps", "description": "Intention : RETRIEVER findLsps: instance-level [object finder] (retriever) API findLsps of class mpls.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsPolicyFindLsps" }, "task": true }, { "name": "restMplsSharedRiskLinkGroupFindInterfaces", "summary": "findInterfaces", "description": "Intention : RETRIEVER findInterfaces: instance-level [object finder] (retriever) API findInterfaces of class mpls.SharedRiskLinkGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsSharedRiskLinkGroupFindInterfaces" }, "task": true }, { "name": "restMplsSiteConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class mpls.Site This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restMplsSiteConfigure" }, "task": true }, { "name": "restMplsTunnelConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: class-level [hierarchical administrative configuration/modification] (modifier) API configure of class mpls.Tunnel This API follows hierarchical config model rules.", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"administrativeState\": 123, \"pathId\": 123, \"displayedName\": \"string\", \"description\": \"string\", \"sourceNodeId\": \"string\", \"destinationNodeId\": \"string\", \"pathMtu\": 123, \"forwardingClasses\": 123, \"priority\": 123, \"provisionedPathId\": 123, \"tunnelInstance\": 123, \"ingressLabelSwitchRouterId\": 123, \"egressLabelSwitchRouterId\": 123, \"lspId\": 123, \"hopIdToAddressList\": \"array\", \"customProperties\": \"object\", \"isSIDConfiguredOnHops\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "administrativeState": { "type": "integer" }, "pathId": { "type": "integer" }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "sourceNodeId": { "type": "string" }, "destinationNodeId": { "type": "string" }, "pathMtu": { "type": "integer" }, "forwardingClasses": { "type": "integer" }, "priority": { "type": "integer" }, "provisionedPathId": { "type": "integer" }, "tunnelInstance": { "type": "integer" }, "ingressLabelSwitchRouterId": { "type": "integer" }, "egressLabelSwitchRouterId": { "type": "integer" }, "lspId": { "type": "integer" }, "hopIdToAddressList": { "type": "array", "items": { "type": "string" } }, "customProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "isSIDConfiguredOnHops": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface ConfigInfo TunnelConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restMplsTunnelConfigure" }, "task": true }, { "name": "restMplsTunnelConfigureTunnelAndPath", "summary": "configureTunnelAndPath", "description": "Create the mpls.Tunnel and mpls.ProvisionedPath in conjunction with each other. This method should only be used to create, not modify, the tunnel and path. Use the generic configure methods in generic.GenericObject. NOTE: Only paths with hops are actually created. A hop-less path will result in no object being created and the returned pathDn being set to nothing. Intention : MODIFIER configureTunnelAndPath: class-level [hierarchical administrative configuration/modification] (modifier) API...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"pathConfigInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"administrativeState\": 123, \"pathId\": 123, \"displayedName\": \"string\", \"description\": \"string\", \"sourceNodeId\": \"string\", \"destinationNodeId\": \"string\", \"pathMtu\": 123, \"forwardingClasses\": 123}, \"tunnelConfigInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"administrativeState\": 123, \"pathId\": 123, \"displayedName\": \"string\", \"description\": \"string\", \"sourceNodeId\": \"string\", \"destinationNodeId\": \"string\", \"pathMtu\": 123, \"forwardingClasses\": 123, \"priority\": 123, \"provisionedPathId\": 123, \"tunnelInstance\": 123, \"ingressLabelSwitchRouterId\": 123, \"egressLabelSwitchRouterId\": 123, \"lspId\": 123, \"hopIdToAddressList\": \"array\", \"customProperties\": \"object\", \"isSIDConfiguredOnHops\": \"boolean\"}}", "required": false, "schema": { "type": "object", "required": [ "pathConfigInfo", "tunnelConfigInfo" ], "properties": { "pathConfigInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "administrativeState": { "type": "integer" }, "pathId": { "type": "integer" }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "sourceNodeId": { "type": "string" }, "destinationNodeId": { "type": "string" }, "pathMtu": { "type": "integer" }, "forwardingClasses": { "type": "integer" } }, "description": "Model containing the method level model for Interface ConfigInfo PathConfigInfo. to decode json data to internal NFM-P object model" }, "tunnelConfigInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "administrativeState": { "type": "integer" }, "pathId": { "type": "integer" }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "sourceNodeId": { "type": "string" }, "destinationNodeId": { "type": "string" }, "pathMtu": { "type": "integer" }, "forwardingClasses": { "type": "integer" }, "priority": { "type": "integer" }, "provisionedPathId": { "type": "integer" }, "tunnelInstance": { "type": "integer" }, "ingressLabelSwitchRouterId": { "type": "integer" }, "egressLabelSwitchRouterId": { "type": "integer" }, "lspId": { "type": "integer" }, "hopIdToAddressList": { "type": "array", "items": { "type": "string" } }, "customProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "isSIDConfiguredOnHops": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface ConfigInfo TunnelConfigInfo. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for Tunnel.configureTunnelAndPath to decode json data to internal NFM-P object model" } } ], "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": "/restMplsTunnelConfigureTunnelAndPath" }, "task": true }, { "name": "restMplsTunnelFindActualPath", "summary": "findActualPath", "description": "Intention : RETRIEVER findActualPath: instance-level [object finder] (retriever) API findActualPath of class mpls.Tunnel instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsTunnelFindActualPath" }, "task": true }, { "name": "restMplsTunnelFindLspPaths", "summary": "findLspPaths", "description": "Intention : RETRIEVER findLspPaths: instance-level [object finder] (retriever) API findLspPaths of class mpls.Tunnel instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsTunnelFindLspPaths" }, "task": true }, { "name": "restMplsTunnelFindLsps", "summary": "findLsps", "description": "Intention : RETRIEVER findLsps: instance-level [object finder] (retriever) API findLsps of class mpls.Tunnel instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"lspPathFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"lspFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "lspFilter", "lspPathFilter" ], "properties": { "lspPathFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "lspFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for Tunnel.findLsps to decode json data to internal NFM-P object model" } } ], "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": "/restMplsTunnelFindLsps" }, "task": true }, { "name": "restMplsTunnelFindP2mpLsps", "summary": "findP2mpLsps", "description": "Intention : RETRIEVER findP2mpLsps: instance-level [object finder] (retriever) API findP2mpLsps of class mpls.Tunnel instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"s2lPathFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"lspFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "lspFilter", "s2lPathFilter" ], "properties": { "s2lPathFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "lspFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for Tunnel.findP2mpLsps to decode json data to internal NFM-P object model" } } ], "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": "/restMplsTunnelFindP2mpLsps" }, "task": true }, { "name": "restMplsTunnelFindProvisionedPath", "summary": "findProvisionedPath", "description": "Intention : RETRIEVER findProvisionedPath: instance-level [object finder] (retriever) API findProvisionedPath of class mpls.Tunnel instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsTunnelFindProvisionedPath" }, "task": true }, { "name": "restMplsTunnelFindS2lPaths", "summary": "findS2lPaths", "description": "Intention : RETRIEVER findS2lPaths: instance-level [object finder] (retriever) API findS2lPaths of class mpls.Tunnel instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplsTunnelFindS2lPaths" }, "task": true }, { "name": "restMplstpBFDTemplateFindP2PLsp", "summary": "findP2PLsp", "description": "Intention : RETRIEVER findP2PLsp: instance-level [object finder] (retriever) API findP2PLsp of class mplstp.BFDTemplate instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMplstpBFDTemplateFindP2PLsp" }, "task": true }, { "name": "restMplstpGlobalTPLspCreateWithAutoFillForCompleteConnections", "summary": "rest_mplstp_GlobalTPLsp_createWithAutoFillForCompleteConnections", "description": "rest_mplstp_GlobalTPLsp_createWithAutoFillForCompleteConnections", "input": [ { "name": "body", "type": "object", "info": ": {\"configInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"globalTPLspId\": 123, \"lspIdAutoAssigned\": \"boolean\", \"displayedName\": \"string\", \"ipAddressType\": 123, \"tpLspNameA\": \"string\", \"tpLspNameB\": \"string\", \"pathIdA\": 123, \"sourceNodeIdA\": \"string\", \"pathIdB\": 123, \"sourceNodeIdB\": \"string\", \"sourceNodePointerA\": \"string\", \"sourceNodePointerB\": \"string\", \"fromNodeIdA\": \"string\", \"toNodeIdA\": \"string\", \"destinationGlobalIdA\": 123, \"destinationTunnelNumberA\": 123, \"fromNodeIdB\": \"string\", \"toNodeIdB\": \"string\", \"destinationGlobalIdB\": 123, \"destinationTunnelNumberB\": 123}, \"workingPathReverseOutLinkPointerList\": \"array\", \"workingPathStaticHopNameList\": \"array\", \"protectingPathReverseOutLinkPointerList\": \"array\", \"protectingPathStaticHopNameList\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "configInfo", "protectingPathReverseOutLinkPointerList", "protectingPathStaticHopNameList", "workingPathReverseOutLinkPointerList", "workingPathStaticHopNameList" ], "properties": { "configInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "globalTPLspId": { "type": "integer" }, "lspIdAutoAssigned": { "type": "boolean", "default": false }, "displayedName": { "type": "string" }, "ipAddressType": { "type": "integer" }, "tpLspNameA": { "type": "string" }, "tpLspNameB": { "type": "string" }, "pathIdA": { "type": "integer" }, "sourceNodeIdA": { "type": "string" }, "pathIdB": { "type": "integer" }, "sourceNodeIdB": { "type": "string" }, "sourceNodePointerA": { "type": "string" }, "sourceNodePointerB": { "type": "string" }, "fromNodeIdA": { "type": "string" }, "toNodeIdA": { "type": "string" }, "destinationGlobalIdA": { "type": "integer" }, "destinationTunnelNumberA": { "type": "integer" }, "fromNodeIdB": { "type": "string" }, "toNodeIdB": { "type": "string" }, "destinationGlobalIdB": { "type": "integer" }, "destinationTunnelNumberB": { "type": "integer" } }, "description": "Model containing the method level model for Interface ConfigInfo GlobalTPLspConfigInfo. to decode json data to internal NFM-P object model" }, "workingPathReverseOutLinkPointerList": { "type": "array", "description": " An ordered list of reverse out-link interface pointers for the working path (from LER A towards LER B, one direction only), if theworking path is configured.{p}In the given example above, the workingPathReverseOutLinkPointerList will contain MPLS interface pointers for a1, c and d.", "items": { "type": "string" } }, "workingPathStaticHopNameList": { "type": "array", "description": " An ordered list of names for the static hops to be created for the working path (from LER A towards LER B, one direction only), if theworking path is configured.{p}In the given example above, the workingPathStaticHopNameList will contain the LSR path names for C and D.", "items": { "type": "string" } }, "protectingPathReverseOutLinkPointerList": { "type": "array", "description": " An ordered list of reverse out-link interface pointers for the protecting path (from LER A towards LER B, one direction only), if theprotecting path is configured.{p}In the given example above, the protectingPathReverseOutLinkPointerList will contain MPLS interface pointers for a2, and e.", "items": { "type": "string" } }, "protectingPathStaticHopNameList": { "type": "array", "description": " An ordered list of names for the static hops to be created for the protecting path (from LER A towards LER B, one direction only), if theprotecting path is configured.{p}In the given example above, the protectingPathStaticHopNameList will contain LSR path name for E.", "items": { "type": "string" } } }, "description": "Model containing the method level model for GlobalTPLsp.createWithAutoFillForCompleteConnections to decode json data to internal NFM-P object model" } } ], "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": "/restMplstpGlobalTPLspCreateWithAutoFillForCompleteConnections" }, "task": true }, { "name": "restMplstpGlobalTPLspCreateWithAutoFillForIncompleteConnections", "summary": "rest_mplstp_GlobalTPLsp_createWithAutoFillForIncompleteConnections", "description": "rest_mplstp_GlobalTPLsp_createWithAutoFillForIncompleteConnections", "input": [ { "name": "body", "type": "object", "info": ": {\"configInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"globalTPLspId\": 123, \"lspIdAutoAssigned\": \"boolean\", \"displayedName\": \"string\", \"ipAddressType\": 123, \"tpLspNameA\": \"string\", \"tpLspNameB\": \"string\", \"pathIdA\": 123, \"sourceNodeIdA\": \"string\", \"pathIdB\": 123, \"sourceNodeIdB\": \"string\", \"sourceNodePointerA\": \"string\", \"sourceNodePointerB\": \"string\", \"fromNodeIdA\": \"string\", \"toNodeIdA\": \"string\", \"destinationGlobalIdA\": 123, \"destinationTunnelNumberA\": 123, \"fromNodeIdB\": \"string\", \"toNodeIdB\": \"string\", \"destinationGlobalIdB\": 123, \"destinationTunnelNumberB\": 123}, \"workingPathReverseOutLinkPointerList\": \"array\", \"workingPathForwardOutLinkPointerList\": \"array\", \"workingPathStaticHopNameList\": \"array\", \"protectingPathReverseOutLinkPointerList\": \"array\", \"protectingPathForwardOutLinkPointerList\": \"array\", \"protectingPathStaticHopNameList\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "configInfo", "protectingPathForwardOutLinkPointerList", "protectingPathReverseOutLinkPointerList", "protectingPathStaticHopNameList", "workingPathForwardOutLinkPointerList", "workingPathReverseOutLinkPointerList", "workingPathStaticHopNameList" ], "properties": { "configInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "globalTPLspId": { "type": "integer" }, "lspIdAutoAssigned": { "type": "boolean", "default": false }, "displayedName": { "type": "string" }, "ipAddressType": { "type": "integer" }, "tpLspNameA": { "type": "string" }, "tpLspNameB": { "type": "string" }, "pathIdA": { "type": "integer" }, "sourceNodeIdA": { "type": "string" }, "pathIdB": { "type": "integer" }, "sourceNodeIdB": { "type": "string" }, "sourceNodePointerA": { "type": "string" }, "sourceNodePointerB": { "type": "string" }, "fromNodeIdA": { "type": "string" }, "toNodeIdA": { "type": "string" }, "destinationGlobalIdA": { "type": "integer" }, "destinationTunnelNumberA": { "type": "integer" }, "fromNodeIdB": { "type": "string" }, "toNodeIdB": { "type": "string" }, "destinationGlobalIdB": { "type": "integer" }, "destinationTunnelNumberB": { "type": "integer" } }, "description": "Model containing the method level model for Interface ConfigInfo GlobalTPLspConfigInfo. to decode json data to internal NFM-P object model" }, "workingPathReverseOutLinkPointerList": { "type": "array", "description": " An ordered list of reverse out-link interface pointers for the working path (from LER A towards LER B, one direction only), if theworking path is configured.{p}In the given example above, the workingPathReverseOutLinkPointerList will contain MPLS interface pointers for a1, c2 and d2.", "items": { "type": "string" } }, "workingPathForwardOutLinkPointerList": { "type": "array", "description": " An ordered list of forward out-link interface pointers for the working path (from LER A towards LER B, one direction only), if theworking path is configured.{p}In the given example above, the workingPathForwardOutLinkPointerList will contain MPLS interface pointers for c1, d1 and b1.", "items": { "type": "string" } }, "workingPathStaticHopNameList": { "type": "array", "description": " An ordered list of names for the static hops to be created for the working path (from LER A towards LER B, one direction only), if theworking path is configured.{p}In the given example above, the workingPathStaticHopNameList will contain LSR path names for C and D.", "items": { "type": "string" } }, "protectingPathReverseOutLinkPointerList": { "type": "array", "description": " An ordered list of reverse out-Link interface pointers for the protecting path (from LER A towards LER B, one direction only), if theprotecting path is configured.{p}In the given example above, the protectingPathReverseOutLinkPointerList will contain MPLS interface pointers for a2 and e2.", "items": { "type": "string" } }, "protectingPathForwardOutLinkPointerList": { "type": "array", "description": " An ordered list of forward out-link interface pointers for the protecting path (from LER A towards LER B, one direction only), if theprotecting path is configured.{p}In the given example above, the protectingPathForwardOutLinkPointerList will contain MPLS interface pointers for e1 and b2.", "items": { "type": "string" } }, "protectingPathStaticHopNameList": { "type": "array", "description": " An ordered list of names for the static hops to be created for the protecting path (from LER A towards LER B, one direction only), if theprotecting path is configured.{p}In the given example above, the protectingPathStaticHopNameList will contain LSR path name for E.", "items": { "type": "string" } } }, "description": "Model containing the method level model for GlobalTPLsp.createWithAutoFillForIncompleteConnections to decode json data to internal NFM-P object model" } } ], "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": "/restMplstpGlobalTPLspCreateWithAutoFillForIncompleteConnections" }, "task": true }, { "name": "restMprBackhaulServiceDeployServiceAction", "summary": "rest_mpr_BackhaulService_deployServiceAction", "description": "rest_mpr_BackhaulService_deployServiceAction", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restMprBackhaulServiceDeployServiceAction" }, "task": true }, { "name": "restMsappolicyPolicyRequestClearIdleOnlyMsaps", "summary": "requestClearIdleOnlyMsaps", "description": "Request clearing of idle MSAPs using this local policy. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearIdleOnlyMsaps: class-level modifier API requestClearIdleOnlyMsaps of class msappolicy.Policy A request handle which allows the retrieval of the...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"aInPolicyName\": \"string\", \"aInSiteId\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInPolicyName": { "type": "string" }, "aInSiteId": { "type": "string" } }, "description": "Model containing the method level model for Policy.requestClearIdleOnlyMsaps to decode json data to internal NFM-P object model" } } ], "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": "/restMsappolicyPolicyRequestClearIdleOnlyMsaps" }, "task": true }, { "name": "restMsappolicyPolicyRequestClearMsaps", "summary": "requestClearMsaps", "description": "Request clearing of MSAPs using this local policy. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearMsaps: instance-level modifier API requestClearMsaps of class msappolicy.Policy instanceFullName : distinguished/instance name of called object A re...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMsappolicyPolicyRequestClearMsaps" }, "task": true }, { "name": "restMulticastEgressMcastGroupFindAccessInterfaces", "summary": "findAccessInterfaces", "description": "Intention : RETRIEVER findAccessInterfaces: instance-level [object finder] (retriever) API findAccessInterfaces of class multicast.EgressMcastGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMulticastEgressMcastGroupFindAccessInterfaces" }, "task": true }, { "name": "restMulticastIngrPathMgmtOperationalChannelMdaRetrieveChannels", "summary": "retrieveChannels", "description": "Retrieve the operational Ingress Multicast Path Management channels on a specific MDA. Intention : RETRIEVER retrieveChannels: class-level retriever API retrieveChannels of class multicast.IngrPathMgmtOperationalChannelMda List of IngrPathMgmtOperationalChannelMdaInfo.", "input": [ { "name": "body", "type": "object", "info": ": {\"aInRtrId\": \"string\", \"shelfId\": 123, \"slotId\": 123, \"daughterCardSlotId\": 123, \"timeout\": 123, \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "daughterCardSlotId", "filter", "shelfId", "slotId", "timeout" ], "properties": { "aInRtrId": { "type": "string" }, "shelfId": { "type": "integer", "description": " ShelfId of the MDA." }, "slotId": { "type": "integer", "description": " Slot number of the MDA." }, "daughterCardSlotId": { "type": "integer", "description": " Daughter card slot of the MDA." }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns." }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for IngrPathMgmtOperationalChannelMda.retrieveChannels to decode json data to internal NFM-P object model" } } ], "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": "/restMulticastIngrPathMgmtOperationalChannelMdaRetrieveChannels" }, "task": true }, { "name": "restMulticastIngrPathMgmtOperationalChannelSvcRetrieveVRtrChannels", "summary": "retrieveVRtrChannels", "description": "Retrieve the operational Ingress Multicast Path Management channels used by a specific VPRN service or Default routing instance. Intention : RETRIEVER retrieveVRtrChannels: class-level retriever API retrieveVRtrChannels of class multicast.IngrPathMgmtOperationalChannelSvc List of IngrPathMgmtOperationalChannelSvcInfo.", "input": [ { "name": "body", "type": "object", "info": ": {\"aInRtrId\": \"string\", \"aInVRtrId\": 123, \"timeout\": 123, \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter", "timeout" ], "properties": { "aInRtrId": { "type": "string" }, "aInVRtrId": { "type": "integer" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns." }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for IngrPathMgmtOperationalChannelSvc.retrieveVRtrChannels to decode json data to internal NFM-P object model" } } ], "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": "/restMulticastIngrPathMgmtOperationalChannelSvcRetrieveVRtrChannels" }, "task": true }, { "name": "restMulticastIngrPathMgmtOperationalChannelSvcRetrieveVplsChannels", "summary": "retrieveVplsChannels", "description": "Retrieve the operational Ingress Multicast Path Management channels used by a specific VPLS service. Intention : RETRIEVER retrieveVplsChannels: class-level retriever API retrieveVplsChannels of class multicast.IngrPathMgmtOperationalChannelSvc List of IngrPathMgmtOperationalChannelSvcInfo.", "input": [ { "name": "body", "type": "object", "info": ": {\"aInRtrId\": \"string\", \"svcId\": 123, \"timeout\": 123, \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter", "svcId", "timeout" ], "properties": { "aInRtrId": { "type": "string" }, "svcId": { "type": "integer", "description": " The service ID of the VPLS service." }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns." }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for IngrPathMgmtOperationalChannelSvc.retrieveVplsChannels to decode json data to internal NFM-P object model" } } ], "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": "/restMulticastIngrPathMgmtOperationalChannelSvcRetrieveVplsChannels" }, "task": true }, { "name": "restMulticastPolicyGroupEntryFind", "summary": "find", "description": "Intention : RETRIEVER find: class-level [object finder] (retriever) API find of class multicast.PolicyGroupEntry List of multicast.PolicyGroupEntry items.", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMulticastPolicyGroupEntryFind" }, "task": true }, { "name": "restMulticastmgrDomainFindGroupDomainBinding", "summary": "findGroupDomainBinding", "description": "Intention : RETRIEVER findGroupDomainBinding: instance-level [object finder] (retriever) API findGroupDomainBinding of class multicastmgr.Domain DescendantInfo: multicastmgr.PimDomain instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMulticastmgrDomainFindGroupDomainBinding" }, "task": true }, { "name": "restMulticastmgrGroupSyncGroups", "summary": "rest_multicastmgr_Group_syncGroups", "description": "rest_multicastmgr_Group_syncGroups", "input": [ { "name": "body", "type": "object", "info": ": {\"aInDomainId\": 123, \"aInMCNWId\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInDomainId": { "type": "integer" }, "aInMCNWId": { "type": "integer" } }, "description": "Model containing the method level model for Group.syncGroups to decode json data to internal NFM-P object model" } } ], "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": "/restMulticastmgrGroupSyncGroups" }, "task": true }, { "name": "restMulticastmgrMulticastNetworkCreateMulticastNetwork", "summary": "rest_multicastmgr_MulticastNetwork_createMulticastNetwork", "description": "rest_multicastmgr_MulticastNetwork_createMulticastNetwork", "input": [ { "name": "body", "type": "object", "info": ": {\"nwId\": 123, \"description\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "description", "nwId" ], "properties": { "nwId": { "type": "integer", "description": " " }, "description": { "type": "string", "description": " " } }, "description": "Model containing the method level model for MulticastNetwork.createMulticastNetwork to decode json data to internal NFM-P object model" } } ], "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": "/restMulticastmgrMulticastNetworkCreateMulticastNetwork" }, "task": true }, { "name": "restMulticastmgrPimDomainAddRoutersToDomain", "summary": "rest_multicastmgr_PimDomain_addRoutersToDomain", "description": "rest_multicastmgr_PimDomain_addRoutersToDomain", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMulticastmgrPimDomainAddRoutersToDomain" }, "task": true }, { "name": "restMulticastmgrPimDomainDeleteSGFromDomain", "summary": "rest_multicastmgr_PimDomain_deleteSGFromDomain", "description": "rest_multicastmgr_PimDomain_deleteSGFromDomain", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMulticastmgrPimDomainDeleteSGFromDomain" }, "task": true }, { "name": "restMulticastmgrPimDomainRemoveRoutersFromDomain", "summary": "rest_multicastmgr_PimDomain_removeRoutersFromDomain", "description": "rest_multicastmgr_PimDomain_removeRoutersFromDomain", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMulticastmgrPimDomainRemoveRoutersFromDomain" }, "task": true }, { "name": "restMulticastmgrPimDomainResyncAnycastRPTable", "summary": "rest_multicastmgr_PimDomain_resyncAnycastRPTable", "description": "rest_multicastmgr_PimDomain_resyncAnycastRPTable", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMulticastmgrPimDomainResyncAnycastRPTable" }, "task": true }, { "name": "restMulticastmgrPimDomainResyncRPTable", "summary": "rest_multicastmgr_PimDomain_resyncRPTable", "description": "rest_multicastmgr_PimDomain_resyncRPTable", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restMulticastmgrPimDomainResyncRPTable" }, "task": true }, { "name": "restMultichassisAbstractMultiChassisPeerFindInstanceContainedPeers", "summary": "findInstanceContainedPeers", "description": "Intention : RETRIEVER findInstanceContainedPeers: instance-level [object finder] (retriever) API findInstanceContainedPeers of class multichassis.AbstractMultiChassisPeer DescendantInfo: multichassis.PSSMultiChassisPeer DescendantInfo: multichassis.MultiChassisPeer instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMultichassisAbstractMultiChassisPeerFindInstanceContainedPeers" }, "task": true }, { "name": "restMultichassisAbstractMultiChassisPeerPushDownPeerSyncSymmetricalConfig", "summary": "rest_multichassis_AbstractMultiChassisPeer_pushDownPeerSyncSymmetricalConfig", "description": "rest_multichassis_AbstractMultiChassisPeer_pushDownPeerSyncSymmetricalConfig", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"distinguishedName\": \"string\", \"configInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}}", "required": false, "schema": { "type": "object", "required": [ "configInfo", "distinguishedName" ], "properties": { "distinguishedName": { "type": "string", "description": " Distinguished Name of object being configured." }, "configInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for AbstractMultiChassisPeer.pushDownPeerSyncSymmetricalConfig to decode json data to internal NFM-P object model" } } ], "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": "/restMultichassisAbstractMultiChassisPeerPushDownPeerSyncSymmetricalConfig" }, "task": true }, { "name": "restMultichassisAbstractMultiChassisPeerResetPeerSyncProtocols", "summary": "resetPeerSyncProtocols", "description": "Request reset the synchronization protocols if they are mismatched on two sites Intention : MODIFIER resetPeerSyncProtocols: instance-level modifier API resetPeerSyncProtocols of class multichassis.AbstractMultiChassisPeer DescendantInfo: multichassis.PSSMultiChassisPeer DescendantInfo: multichassis.MultiChassisPeer instanceFullName : distinguished/instance name of called object Resulting objects list.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restMultichassisAbstractMultiChassisPeerResetPeerSyncProtocols" }, "task": true }, { "name": "restMultichassisMcOmcrStatResyncMcOmcrStat", "summary": "rest_multichassis_McOmcrStat_resyncMcOmcrStat", "description": "rest_multichassis_McOmcrStat_resyncMcOmcrStat", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restMultichassisMcOmcrStatResyncMcOmcrStat" }, "task": true }, { "name": "restMultichassisMultiChassisIPSecGroupForceTagSync", "summary": "rest_multichassis_MultiChassisIPSecGroup_forceTagSync", "description": "rest_multichassis_MultiChassisIPSecGroup_forceTagSync", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMultichassisMultiChassisIPSecGroupForceTagSync" }, "task": true }, { "name": "restMultichassisMultiChassisMobileGatewayGroupMobilePeerSwitchOver", "summary": "rest_multichassis_MultiChassisMobileGatewayGroup_mobilePeerSwitchOver", "description": "rest_multichassis_MultiChassisMobileGatewayGroup_mobilePeerSwitchOver", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restMultichassisMultiChassisMobileGatewayGroupMobilePeerSwitchOver" }, "task": true }, { "name": "restMultichassisMultiChassisMobileGatewayGroupMobilePeerSwitchOverAbort", "summary": "rest_multichassis_MultiChassisMobileGatewayGroup_mobilePeerSwitchOverAbort", "description": "rest_multichassis_MultiChassisMobileGatewayGroup_mobilePeerSwitchOverAbort", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMultichassisMultiChassisMobileGatewayGroupMobilePeerSwitchOverAbort" }, "task": true }, { "name": "restMultichassisMultiChassisMobileGatewayGroupMobilePeerSwitchOverNow", "summary": "rest_multichassis_MultiChassisMobileGatewayGroup_mobilePeerSwitchOverNow", "description": "rest_multichassis_MultiChassisMobileGatewayGroup_mobilePeerSwitchOverNow", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMultichassisMultiChassisMobileGatewayGroupMobilePeerSwitchOverNow" }, "task": true }, { "name": "restMultichassisMultiChassisPeerGetDependencyCount", "summary": "getDependencyCount", "description": "Intention : RETRIEVER getDependencyCount: instance-level retriever API getDependencyCount of class multichassis.MultiChassisPeer instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMultichassisMultiChassisPeerGetDependencyCount" }, "task": true }, { "name": "restMultichassisMultiChassisPeerMobileGatewayMobilePeerSwitchOver", "summary": "rest_multichassis_MultiChassisPeerMobileGateway_mobilePeerSwitchOver", "description": "rest_multichassis_MultiChassisPeerMobileGateway_mobilePeerSwitchOver", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restMultichassisMultiChassisPeerMobileGatewayMobilePeerSwitchOver" }, "task": true }, { "name": "restMultichassisMultiChassisPeerMobileGatewayMobilePeerSwitchOverAbort", "summary": "rest_multichassis_MultiChassisPeerMobileGateway_mobilePeerSwitchOverAbort", "description": "rest_multichassis_MultiChassisPeerMobileGateway_mobilePeerSwitchOverAbort", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMultichassisMultiChassisPeerMobileGatewayMobilePeerSwitchOverAbort" }, "task": true }, { "name": "restMultichassisMultiChassisPeerMobileGatewayMobilePeerSwitchOverNow", "summary": "rest_multichassis_MultiChassisPeerMobileGateway_mobilePeerSwitchOverNow", "description": "rest_multichassis_MultiChassisPeerMobileGateway_mobilePeerSwitchOverNow", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMultichassisMultiChassisPeerMobileGatewayMobilePeerSwitchOverNow" }, "task": true }, { "name": "restMultichassisMultiChassisRingNodeFindAssociatedVplsSaps", "summary": "findAssociatedVplsSaps", "description": "Return a list of VPLS MVPLS SAPs that are protected by the Multi-Chassis Ring and associated with this ring node. Intention : RETRIEVER findAssociatedVplsSaps: instance-level [object finder] (retriever) API findAssociatedVplsSaps of class multichassis.MultiChassisRingNode instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMultichassisMultiChassisRingNodeFindAssociatedVplsSaps" }, "task": true }, { "name": "restMultichassisMultiChassisRingNodeFindReferencedSaps", "summary": "findReferencedSaps", "description": "Return the list of the Multi Chassis Ring protected EPIPE L2 Access Interface which has the reference of this ring node. Intention : RETRIEVER findReferencedSaps: instance-level [object finder] (retriever) API findReferencedSaps of class multichassis.MultiChassisRingNode instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMultichassisMultiChassisRingNodeFindReferencedSaps" }, "task": true }, { "name": "restMultichassisMultiChassisRingNodeFindReferencedStaticHosts", "summary": "findReferencedStaticHosts", "description": "Return the list of the anti-spoofing static host which has the reference of this ring node. Intention : RETRIEVER findReferencedStaticHosts: instance-level [object finder] (retriever) API findReferencedStaticHosts of class multichassis.MultiChassisRingNode instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restMultichassisMultiChassisRingNodeFindReferencedStaticHosts" }, "task": true }, { "name": "restMultichassisPeerSynchronizationProtocolFindSyncTags", "summary": "findSyncTags", "description": "Find all the Sync Tags configured under this MC SynchronizatioProtocol. Intention : RETRIEVER findSyncTags: instance-level [object finder] (retriever) API findSyncTags of class multichassis.PeerSynchronizationProtocol instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"portFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"validForMcRing\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "objectClassName", "portFilter", "validForMcRing" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "portFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "validForMcRing": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for struct FindSyncTagsInputStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restMultichassisPeerSynchronizationProtocolFindSyncTags" }, "task": true }, { "name": "restMvplsL2AccessInterfaceRequestClearIgmpHostTracking", "summary": "requestClearIgmpHostTracking", "description": "Request clearing of all IGMP Host Tracking information for this L2 AccessInterface. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearIgmpHostTracking: instance-level modifier API requestClearIgmpHostTracking of class mvpls.L2AccessInterface instanc...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restMvplsL2AccessInterfaceRequestClearIgmpHostTracking" }, "task": true }, { "name": "restMvplsSiteRequestClearIgmpHostTracking", "summary": "requestClearIgmpHostTracking", "description": "Request clearing of all IGMP Host Tracking information for this site. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearIgmpHostTracking: instance-level modifier API requestClearIgmpHostTracking of class mvpls.Site instanceFullName : distinguished/i...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restMvplsSiteRequestClearIgmpHostTracking" }, "task": true }, { "name": "restMwaPortTerminationGetDependencyCount", "summary": "getDependencyCount", "description": "Intention : RETRIEVER getDependencyCount: instance-level retriever API getDependencyCount of class mwa.PortTermination instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMwaPortTerminationGetDependencyCount" }, "task": true }, { "name": "restMwaPortTerminationRebootRadio", "summary": "rest_mwa_PortTermination_rebootRadio", "description": "rest_mwa_PortTermination_rebootRadio", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restMwaPortTerminationRebootRadio" }, "task": true }, { "name": "restNatAbstractLsnSubscriberQueryLsnSubscribers", "summary": "queryLsnSubscribers", "description": "This method is used to query the NE for LSN Subscriber(s) exists on a specified routing instance (Base or VPRN) and the subscriber inside IP Address. This method is only applicable to the node with version 12.0 and above. Intention : RETRIEVER queryLsnSubscribers: class-level retriever API queryLsnSubscribers of class nat.AbstractLsnSubscriber DescendantInfo: nat.ClassicLsnHost DescendantInfo: nat.Nat64Subscriber DescendantInfo: nat.DsLiteSubscriber", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"subType\": \"string\", \"siteId\": \"string\", \"routingInstance\": \"string\", \"subInsideAddr\": \"string\", \"subInsideAddrPfxL\": 123, \"shouldRetrieveBlkAlloc\": \"boolean\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "objectClassName", "routingInstance", "shouldRetrieveBlkAlloc", "siteId", "subInsideAddr", "subInsideAddrPfxL", "subType", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "subType": { "type": "string" }, "siteId": { "type": "string" }, "routingInstance": { "type": "string" }, "subInsideAddr": { "type": "string" }, "subInsideAddrPfxL": { "type": "integer" }, "shouldRetrieveBlkAlloc": { "type": "boolean", "default": false }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct LsnSubRetrievalStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restNatAbstractLsnSubscriberQueryLsnSubscribers" }, "task": true }, { "name": "restNatClassicLsnHostRetrieveSubIdStrTimestamp", "summary": "retrieveSubIdStrTimestamp", "description": "Retrieves subscriber string association time with classic LSN host. Method used to query the NE for to update the subscriber ID String Timestamp. Intention : RETRIEVER retrieveSubIdStrTimestamp: class-level retriever API retrieveSubIdStrTimestamp of class nat.ClassicLsnHost", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInSubIdStr\": \"string\", \"aInSubAddr\": \"string\", \"aInSubIdStrType\": 123, \"aInRouterId\": 123, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInSiteId": { "type": "string" }, "aInSubIdStr": { "type": "string" }, "aInSubAddr": { "type": "string" }, "aInSubIdStrType": { "type": "integer" }, "aInRouterId": { "type": "integer" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait before receiving the results. If no results arereceived in the given time, the method returns.This is an optional input parameter. The default value is 5 minutes (300000). default:300000" } }, "description": "Model containing the method level model for ClassicLsnHost.retrieveSubIdStrTimestamp to decode json data to internal NFM-P object model" } } ], "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": "/restNatClassicLsnHostRetrieveSubIdStrTimestamp" }, "task": true }, { "name": "restNatFirewallHostRetrieveFirewallHosts", "summary": "retrieveFirewallHosts", "description": "Method used to query the NE for the Firewall Hosts related to the specified NAT L2 Aware Subscriber. Intention : RETRIEVER retrieveFirewallHosts: class-level retriever API retrieveFirewallHosts of class nat.FirewallHost", "input": [ { "name": "body", "type": "object", "info": ": {\"aInFirewallHostRtrvStruct\": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"residentialSubIdent\": \"string\", \"ipAddrPrefix\": \"string\", \"prefixLength\": 123, \"macAddress\": \"string\", \"firewallPolicy\": \"string\"}, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInFirewallHostRtrvStruct": { "type": "object", "required": [ "firewallPolicy", "ipAddrPrefix", "macAddress", "objectClassName", "prefixLength", "residentialSubIdent", "siteId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "residentialSubIdent": { "type": "string" }, "ipAddrPrefix": { "type": "string" }, "prefixLength": { "type": "integer" }, "macAddress": { "type": "string" }, "firewallPolicy": { "type": "string" } }, "description": "Model containing the method level model for struct FirewallHostRtrvStruct. to decode json data to internal NFM-P object model" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait before receiving the results.This is an optional input parameter. The default value is 5 minutes (300000). default:300000" } }, "description": "Model containing the method level model for FirewallHost.retrieveFirewallHosts to decode json data to internal NFM-P object model" } } ], "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": "/restNatFirewallHostRetrieveFirewallHosts" }, "task": true }, { "name": "restNatIsaMdaRequestRecoverL2AwBypass", "summary": "requestRecoverL2AwBypass", "description": "This method restores NAT resources to the recovered MS-ISA and resume forwarding subscriber traffic through it (tool performs nat recover-l2aw-bypass slot mda). Intention : RETRIEVER requestRecoverL2AwBypass: class-level retriever API requestRecoverL2AwBypass of class nat.IsaMda", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInTimeout\": 123, \"aInMdaNumber\": 123, \"aInSlotNumber\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInTimeout": { "type": "integer" }, "aInMdaNumber": { "type": "integer" }, "aInSlotNumber": { "type": "integer" } }, "description": "Model containing the method level model for IsaMda.requestRecoverL2AwBypass to decode json data to internal NFM-P object model" } } ], "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": "/restNatIsaMdaRequestRecoverL2AwBypass" }, "task": true }, { "name": "restNatL2AwHostsRetrieveL2AwHosts", "summary": "retrieveL2AwHosts", "description": "Method used to query the NE for the NAT L2 Aware Hosts related to the specified NAT L2 Aware Subscriber. Intention : RETRIEVER retrieveL2AwHosts: class-level retriever API retrieveL2AwHosts of class nat.L2AwHosts", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInResidentialSubIdent\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInSiteId": { "type": "string" }, "aInResidentialSubIdent": { "type": "string" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait before receiving the results.This is an optional input parameter. The default value is 5 minutes (300000). default:300000" } }, "description": "Model containing the method level model for L2AwHosts.retrieveL2AwHosts to decode json data to internal NFM-P object model" } } ], "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": "/restNatL2AwHostsRetrieveL2AwHosts" }, "task": true }, { "name": "restNatL2AwSubscriberRetrieveL2AwareSubscribers", "summary": "rest_nat_L2AwSubscriber_retrieveL2AwareSubscribers", "description": "rest_nat_L2AwSubscriber_retrieveL2AwareSubscribers", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInresidentialSubscriber\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInresidentialSubscriber": { "type": "string" } }, "description": "Model containing the method level model for L2AwSubscriber.retrieveL2AwareSubscribers to decode json data to internal NFM-P object model" } } ], "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": "/restNatL2AwSubscriberRetrieveL2AwareSubscribers" }, "task": true }, { "name": "restNatL2AwareBlockAllocationRetrieveL2AwareBlockAllocations", "summary": "retrieveL2AwareBlockAllocations", "description": "Method used to query the NE for the L2 Aware Block Allocations related to the specified NAT L2 Aware Subscriber. Intention : RETRIEVER retrieveL2AwareBlockAllocations: class-level retriever API retrieveL2AwareBlockAllocations of class nat.L2AwareBlockAllocation", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInResidentialSubIdent\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInSiteId": { "type": "string" }, "aInResidentialSubIdent": { "type": "string" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait before receiving the results.This is an optional input parameter. The default value is 5 minutes (300000). default:300000" } }, "description": "Model containing the method level model for L2AwareBlockAllocation.retrieveL2AwareBlockAllocations to decode json data to internal NFM-P object model" } } ], "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": "/restNatL2AwareBlockAllocationRetrieveL2AwareBlockAllocations" }, "task": true }, { "name": "restNatL2AwareNatSubscriberPoliciesRetrieveL2AwareNatSubscriberPolicies", "summary": "retrieveL2AwareNatSubscriberPolicies", "description": "Method used to query the NE for the L2 Aware NAT Subscriber Policies related to the specified NAT L2 Aware Subscriber. Intention : RETRIEVER retrieveL2AwareNatSubscriberPolicies: class-level retriever API retrieveL2AwareNatSubscriberPolicies of class nat.L2AwareNatSubscriberPolicies", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInResidentialSubIdent\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInSiteId": { "type": "string" }, "aInResidentialSubIdent": { "type": "string" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait before receiving the results.This is an optional input parameter. The default value is 5 minutes (300000). default:300000" } }, "description": "Model containing the method level model for L2AwareNatSubscriberPolicies.retrieveL2AwareNatSubscriberPolicies to decode json data to internal NFM-P object model" } } ], "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": "/restNatL2AwareNatSubscriberPoliciesRetrieveL2AwareNatSubscriberPolicies" }, "task": true }, { "name": "restNatLsnBlockAllocationRetrieveLsnBlockAllocations", "summary": "retrieveLsnBlockAllocations", "description": "Method used to query the NE for the Block Allocations that on a specified routing instance (Base or VPRN) and the Block Allocation outside IP Address. Intention : RETRIEVER retrieveLsnBlockAllocations: class-level retriever API retrieveLsnBlockAllocations of class nat.LsnBlockAllocation", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInAddr\": \"string\", \"aInStartPort\": 123, \"aInRouterId\": 123, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInSiteId": { "type": "string" }, "aInAddr": { "type": "string" }, "aInStartPort": { "type": "integer" }, "aInRouterId": { "type": "integer" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait before receiving the results. If no results arereceived in the given time, the method returns.This is an optional input parameter. The default value is 5 minutes (300000). default:300000" } }, "description": "Model containing the method level model for LsnBlockAllocation.retrieveLsnBlockAllocations to decode json data to internal NFM-P object model" } } ], "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": "/restNatLsnBlockAllocationRetrieveLsnBlockAllocations" }, "task": true }, { "name": "restNatNatIsaGroupFindDaughterCards", "summary": "findDaughterCards", "description": "Intention : RETRIEVER findDaughterCards: instance-level [object finder] (retriever) API findDaughterCards of class nat.NatIsaGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "isaGroup", "type": "number", "info": ": 123", "required": false, "schema": { "title": "isaGroup", "type": "number" } } ], "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": "/restNatNatIsaGroupFindDaughterCards" }, "task": true }, { "name": "restNatNatIsaGroupGetDependencyCount", "summary": "getDependencyCount", "description": "Intention : RETRIEVER getDependencyCount: instance-level retriever API getDependencyCount of class nat.NatIsaGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNatNatIsaGroupGetDependencyCount" }, "task": true }, { "name": "restNatNatIsaGroupConfGetReassemblyGroups", "summary": "getReassemblyGroups", "description": "Intention : RETRIEVER getReassemblyGroups: class-level retriever API getReassemblyGroups of class nat.NatIsaGroupConf DescendantInfo: wlangw.WlanGwIsaGroup DescendantInfo: nat.NatIsaGroup", "input": [ { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "isaGroup", "type": "number", "info": ": 123", "required": false, "schema": { "title": "isaGroup", "type": "number" } } ], "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": "/restNatNatIsaGroupConfGetReassemblyGroups" }, "task": true }, { "name": "restNatNatPoolRequestNatPoolHistogram", "summary": "requestNatPoolHistogram", "description": "This method allows to request the creation of a port usage histogram for a given NAT pool. Intention : RETRIEVER requestNatPoolHistogram: class-level retriever API requestNatPoolHistogram of class nat.NatPool", "input": [ { "name": "body", "type": "object", "info": ": {\"aInNatPoolFullName\": \"string\", \"aInBucketSize\": 123, \"aInNumBuckets\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInNatPoolFullName": { "type": "string" }, "aInBucketSize": { "type": "integer" }, "aInNumBuckets": { "type": "integer" } }, "description": "Model containing the method level model for NatPool.requestNatPoolHistogram to decode json data to internal NFM-P object model" } } ], "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": "/restNatNatPoolRequestNatPoolHistogram" }, "task": true }, { "name": "restNatNatVappRequestRecoverEsaVm", "summary": "requestRecoverEsaVm", "description": "This method restores NAT resources to the recovered ESA VM and resume forwarding subscriber traffic through it. Intention : RETRIEVER requestRecoverEsaVm: class-level retriever API requestRecoverEsaVm of class nat.NatVapp", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInTimeout\": 123, \"aInEsaNum\": 123, \"aInEsaVappNum\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInTimeout": { "type": "integer" }, "aInEsaNum": { "type": "integer" }, "aInEsaVappNum": { "type": "integer" } }, "description": "Model containing the method level model for NatVapp.requestRecoverEsaVm to decode json data to internal NFM-P object model" } } ], "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": "/restNatNatVappRequestRecoverEsaVm" }, "task": true }, { "name": "restNatStaticPortMapRequestApplyStaticPortMapRequest", "summary": "applyStaticPortMapRequest", "description": "Method will not return errors through exceptions, but will use JMS instead. If the caller is not able to listen to JMS events but is interested in error conditions, 'applyStaticPortMapRequestWithResult' method should be used. For Classic LSN, DS lite LSN and NAT64 LSN successful execution of the function requires that user must provide these parameters, \"actionType\", \"ipAddress\", \"routerId\" and \"nodeId\" for creation. Although, for delete modify \"port\"(inside) value is required along with abov...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"id\": 123, \"nodeId\": \"string\", \"routerId\": 123, \"redundantNodeId\": \"string\", \"redundantRouterId\": 123, \"redundantRouterNamePointer\": \"string\", \"subType\": 123, \"actionType\": 123, \"ipAddressType\": 123, \"ipAddress\": \"string\", \"b4AddressType\": 123, \"ipv6B4Address\": \"string\", \"aftrAddressType\": 123, \"ipv6AftrAddress\": \"string\", \"subIdent\": \"string\", \"port\": 123, \"protocol\": 123, \"outPort\": 123, \"outIpAddressType\": 123, \"outIpAddress\": \"string\", \"actionGo\": 123, \"timeout\": 123, \"success\": \"boolean\", \"lastActionTime\": 123, \"targetRouterInstance\": \"string\", \"supressDuplicateError\": \"boolean\", \"natPolicyPointer\": \"string\", \"redundantNatPolicyPointer\": \"string\", \"natFwdSaveConfig\": \"boolean\", \"creationOrigin\": 123}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "id": { "type": "integer" }, "nodeId": { "type": "string" }, "routerId": { "type": "integer" }, "redundantNodeId": { "type": "string" }, "redundantRouterId": { "type": "integer" }, "redundantRouterNamePointer": { "type": "string" }, "subType": { "type": "integer" }, "actionType": { "type": "integer" }, "ipAddressType": { "type": "integer" }, "ipAddress": { "type": "string" }, "b4AddressType": { "type": "integer" }, "ipv6B4Address": { "type": "string" }, "aftrAddressType": { "type": "integer" }, "ipv6AftrAddress": { "type": "string" }, "subIdent": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "integer" }, "outPort": { "type": "integer" }, "outIpAddressType": { "type": "integer" }, "outIpAddress": { "type": "string" }, "actionGo": { "type": "integer" }, "timeout": { "type": "integer" }, "success": { "type": "boolean", "default": false }, "lastActionTime": { "type": "integer" }, "targetRouterInstance": { "type": "string" }, "supressDuplicateError": { "type": "boolean", "default": false }, "natPolicyPointer": { "type": "string" }, "redundantNatPolicyPointer": { "type": "string" }, "natFwdSaveConfig": { "type": "boolean", "default": false }, "creationOrigin": { "type": "integer" } }, "description": "Model containing the method level model for Interface ConfigInfo StaticPortMapRequestConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restNatStaticPortMapRequestApplyStaticPortMapRequest" }, "task": true }, { "name": "restNatStaticPortMapRequestApplyStaticPortMapRequestWithResult", "summary": "applyStaticPortMapRequestWithResult", "description": "For Classic LSN, DS lite LSN and NAT64 LSN successful execution of the function requires that user must provide these parameters, \"actionType\", \"ipAddress\", \"routerId\" and \"nodeId\" for creation. Although, for delete modify \"port\"(inside) value is required along with above mandatory parameters. However for the parameters \"ipAddresstype\", \"subType\" and \"protocol\" if a value is not defined the default value will be provided before deployment. For L2-Aware type everything remains the same except ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"aInValidate\": \"boolean\", \"aInRequest\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"id\": 123, \"nodeId\": \"string\", \"routerId\": 123, \"redundantNodeId\": \"string\", \"redundantRouterId\": 123, \"redundantRouterNamePointer\": \"string\", \"subType\": 123, \"actionType\": 123, \"ipAddressType\": 123, \"ipAddress\": \"string\", \"b4AddressType\": 123, \"ipv6B4Address\": \"string\", \"aftrAddressType\": 123, \"ipv6AftrAddress\": \"string\", \"subIdent\": \"string\", \"port\": 123, \"protocol\": 123, \"outPort\": 123, \"outIpAddressType\": 123, \"outIpAddress\": \"string\", \"actionGo\": 123, \"timeout\": 123, \"success\": \"boolean\", \"lastActionTime\": 123, \"targetRouterInstance\": \"string\", \"supressDuplicateError\": \"boolean\", \"natPolicyPointer\": \"string\", \"redundantNatPolicyPointer\": \"string\", \"natFwdSaveConfig\": \"boolean\", \"creationOrigin\": 123}}", "required": false, "schema": { "type": "object", "properties": { "aInValidate": { "type": "boolean", "default": false }, "aInRequest": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "id": { "type": "integer" }, "nodeId": { "type": "string" }, "routerId": { "type": "integer" }, "redundantNodeId": { "type": "string" }, "redundantRouterId": { "type": "integer" }, "redundantRouterNamePointer": { "type": "string" }, "subType": { "type": "integer" }, "actionType": { "type": "integer" }, "ipAddressType": { "type": "integer" }, "ipAddress": { "type": "string" }, "b4AddressType": { "type": "integer" }, "ipv6B4Address": { "type": "string" }, "aftrAddressType": { "type": "integer" }, "ipv6AftrAddress": { "type": "string" }, "subIdent": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "integer" }, "outPort": { "type": "integer" }, "outIpAddressType": { "type": "integer" }, "outIpAddress": { "type": "string" }, "actionGo": { "type": "integer" }, "timeout": { "type": "integer" }, "success": { "type": "boolean", "default": false }, "lastActionTime": { "type": "integer" }, "targetRouterInstance": { "type": "string" }, "supressDuplicateError": { "type": "boolean", "default": false }, "natPolicyPointer": { "type": "string" }, "redundantNatPolicyPointer": { "type": "string" }, "natFwdSaveConfig": { "type": "boolean", "default": false }, "creationOrigin": { "type": "integer" } }, "description": "Model containing the method level model for Interface ConfigInfo StaticPortMapRequestConfigInfo. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for StaticPortMapRequest.applyStaticPortMapRequestWithResult to decode json data to internal NFM-P object model" } } ], "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": "/restNatStaticPortMapRequestApplyStaticPortMapRequestWithResult" }, "task": true }, { "name": "restNatStaticPortMapRequestApplyStaticPortMapRequests", "summary": "applyStaticPortMapRequests", "description": "Method will not return errors through exceptions, but will use JMS instead. If the caller is not able to listen to JMS events but is interested in error conditions, 'applyStaticPortMapRequestWithResult' method should be used. For Classic LSN, DS lite LSN and NAT64 LSN successful execution of the function requires that user must provide these parameters, \"actionType\", \"ipAddress\", \"routerId\" and \"nodeId\" for creation. Although, for delete modify \"port\"(inside) value is required along with abov...(description truncated)", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNatStaticPortMapRequestApplyStaticPortMapRequests" }, "task": true }, { "name": "restNatStaticPortMappingRetrieveNatPortForwarding", "summary": "retrieveNatPortForwarding", "description": "Method used to query the NE for the NAT Port Forwarding that on a specified . Intention : RETRIEVER retrieveNatPortForwarding: class-level retriever API retrieveNatPortForwarding of class nat.StaticPortMapping DescendantInfo: nat.StaticPortMappingL2Aware DescendantInfo: nat.StaticPortMappingLsn", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInTimeout\": 123, \"aInType\": \"string\", \"aInL2AwareSubId\": \"string\", \"aInB4AddressType\": \"string\", \"aInIpv6B4Address\": \"string\", \"aInOriginRetrieve\": \"string\", \"aInRouterId\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInTimeout": { "type": "integer" }, "aInType": { "type": "string" }, "aInL2AwareSubId": { "type": "string" }, "aInB4AddressType": { "type": "string" }, "aInIpv6B4Address": { "type": "string" }, "aInOriginRetrieve": { "type": "string" }, "aInRouterId": { "type": "integer" } }, "description": "Model containing the method level model for StaticPortMapping.retrieveNatPortForwarding to decode json data to internal NFM-P object model" } } ], "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": "/restNatStaticPortMappingRetrieveNatPortForwarding" }, "task": true }, { "name": "restNatSvcChainEsiMappingRetrieveEsiMappings", "summary": "retrieveEsiMappings", "description": "Method to retrieve ESI mapping(s) for the specified EVPN (Ethernet VPN). Intention : RETRIEVER retrieveEsiMappings: class-level retriever API retrieveEsiMappings of class nat.SvcChainEsiMapping", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInTimeout\": 123, \"evpnId\": 123, \"esi\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "esi", "evpnId" ], "properties": { "aInSiteId": { "type": "string" }, "aInTimeout": { "type": "integer" }, "evpnId": { "type": "integer", "description": " Specifies EVPN ID. This is mandatory parameter." }, "esi": { "type": "string", "description": " Specifies ESI Mapping IP Address. This is optional parameter. default:" } }, "description": "Model containing the method level model for SvcChainEsiMapping.retrieveEsiMappings to decode json data to internal NFM-P object model" } } ], "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": "/restNatSvcChainEsiMappingRetrieveEsiMappings" }, "task": true }, { "name": "restNatSvcChainIpMappingRetrieveIpMappings", "summary": "retrieveIpMappings", "description": "Method to retrieve IP mapping(s) for the specified EVPN (Ethernet VPN). Intention : RETRIEVER retrieveIpMappings: class-level retriever API retrieveIpMappings of class nat.SvcChainIpMapping", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInTimeout\": 123, \"evpnId\": 123, \"ipAddress\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "evpnId", "ipAddress" ], "properties": { "aInSiteId": { "type": "string" }, "aInTimeout": { "type": "integer" }, "evpnId": { "type": "integer", "description": " Specifies EVPN ID. This is mandatory parameter." }, "ipAddress": { "type": "string", "description": " Specifies Service Forward IP Address. This is optional parameter. default:" } }, "description": "Model containing the method level model for SvcChainIpMapping.retrieveIpMappings to decode json data to internal NFM-P object model" } } ], "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": "/restNatSvcChainIpMappingRetrieveIpMappings" }, "task": true }, { "name": "restNatSvcChainVasFilterPolicyRequestClearIsaSvcChainVasFilter", "summary": "requestClearIsaSvcChainVasFilter", "description": "Request clearing of all NAT Sessions associated with this ISA Service Chaining VAS Filter. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearIsaSvcChainVasFilter: class-level modifier API requestClearIsaSvcChainVasFilter of class nat.SvcChainVasFilte...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"policyName\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "policyName", "siteId" ], "properties": { "siteId": { "type": "string", "description": " Specifies the NE.This is a required input parameter." }, "policyName": { "type": "string", "description": " Specifies the Service Chaining VAS Filter Policy name.This is a required input parameter." } }, "description": "Model containing the method level model for SvcChainVasFilterPolicy.requestClearIsaSvcChainVasFilter to decode json data to internal NFM-P object model" } } ], "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": "/restNatSvcChainVasFilterPolicyRequestClearIsaSvcChainVasFilter" }, "task": true }, { "name": "restNeauditNeAuditAudit", "summary": "rest_neaudit_NeAudit_audit", "description": "rest_neaudit_NeAudit_audit", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNeauditNeAuditAudit" }, "task": true }, { "name": "restNeauditNeAuditManagerTriggerNeAudit", "summary": "triggerNeAudit", "description": "This method starts a request for NE audit. Intention : MODIFIER triggerNeAudit: class-level [functionality trigger] (modifier) API triggerNeAudit on default instance nea-mgr of class neaudit.NeAuditManager", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"fdn\": \"string\", \"includeReadOnlyAttributes\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "fdn", "includeReadOnlyAttributes", "objectClassName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "fdn": { "type": "string" }, "includeReadOnlyAttributes": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for struct NeAuditParam. to decode json data to internal NFM-P object model" } } ], "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": "/restNeauditNeAuditManagerTriggerNeAudit" }, "task": true }, { "name": "restNeauditNeAuditManagerTriggerNesAudit", "summary": "triggerNesAudit", "description": "This method starts a request for multiple NE audits. Intention : MODIFIER triggerNesAudit: class-level [functionality trigger] (modifier) API triggerNesAudit on default instance nea-mgr of class neaudit.NeAuditManager", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNeauditNeAuditManagerTriggerNesAudit" }, "task": true }, { "name": "restNelicenseAbstractNELicenseInstallLicense", "summary": "rest_nelicense_AbstractNELicense_installLicense", "description": "rest_nelicense_AbstractNELicense_installLicense", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNelicenseAbstractNELicenseInstallLicense" }, "task": true }, { "name": "restNetcaCardStatsTCAProfileClearPMCountersForSelected", "summary": "rest_netca_CardStatsTCAProfile_clearPMCountersForSelected", "description": "rest_netca_CardStatsTCAProfile_clearPMCountersForSelected", "input": [ { "name": "body", "type": "object", "info": ": {\"fdns\": \"array\", \"intervalType\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "fdns", "intervalType" ], "properties": { "fdns": { "type": "array", "description": " FDNs of the selected ports, SAPs or SLM DM objects.", "items": { "type": "string" } }, "intervalType": { "type": "string", "description": " Counters to be cleared for the selected Interval type." } }, "description": "Model containing the method level model for CardStatsTCAProfile.clearPMCountersForSelected to decode json data to internal NFM-P object model" } } ], "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": "/restNetcaCardStatsTCAProfileClearPMCountersForSelected" }, "task": true }, { "name": "restNetcaCardStatsTCAProfileFindPorts", "summary": "findPorts", "description": "Intention : RETRIEVER findPorts: instance-level [object finder] (retriever) API findPorts of class netca.CardStatsTCAProfile instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetcaCardStatsTCAProfileFindPorts" }, "task": true }, { "name": "restNetwAbstractPhysicalLinkFindBwUsage", "summary": "findBwUsage", "description": "This is return a list of cac.TunnelServiceMap type objects that are currently using this Physical Link Intention : RETRIEVER findBwUsage: instance-level [object finder] (retriever) API findBwUsage of class netw.AbstractPhysicalLink DescendantInfo: vwm.VwmPhysicalLink DescendantInfo: optical.OpticalLink DescendantInfo: netw.RadioPhysicalLink DescendantInfo: netw.PortTopology DescendantInfo: lteservice.CupsLink DescendantInfo: netw.LagMemberCapableLink DescendantInfo: netw.Disco...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwAbstractPhysicalLinkFindBwUsage" }, "task": true }, { "name": "restNetwAdvertisedNodePurge", "summary": "rest_netw_AdvertisedNode_purge", "description": "rest_netw_AdvertisedNode_purge", "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": "/restNetwAdvertisedNodePurge" }, "task": true }, { "name": "restNetwConnectionTerminationPointFindAvailableAccessCtpsPerNode", "summary": "findAvailableAccessCtpsPerNode", "description": "Intention : RETRIEVER findAvailableAccessCtpsPerNode: class-level [object finder] (retriever) API findAvailableAccessCtpsPerNode of class netw.ConnectionTerminationPoint DescendantInfo: opticalequipment.EthernetCtp DescendantInfo: tdm.AUn DescendantInfo: oth.OdukPtf DescendantInfo: optical.Odu1PtfChannel DescendantInfo: oth.OdukNimSubStructure DescendantInfo: netw.LogicalQosConstrainedInterfaceCtp DescendantInfo: rtr.IpAddressLikeCtp DescendantInfo: rtr.VirtualInterfaceCtp ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"nodeId\": \"string\", \"ctpFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "ctpFilter", "nodeId" ], "properties": { "nodeId": { "type": "string", "description": " " }, "ctpFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findAvailableAccessCtpsPerNode to decode json data to internal NFM-P object model" } } ], "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": "/restNetwConnectionTerminationPointFindAvailableAccessCtpsPerNode" }, "task": true }, { "name": "restNetwConnectionTerminationPointFindAvailableCtpsPerNode", "summary": "findAvailableCtpsPerNode", "description": "Intention : RETRIEVER findAvailableCtpsPerNode: class-level [object finder] (retriever) API findAvailableCtpsPerNode of class netw.ConnectionTerminationPoint DescendantInfo: opticalequipment.EthernetCtp DescendantInfo: tdm.AUn DescendantInfo: oth.OdukPtf DescendantInfo: optical.Odu1PtfChannel DescendantInfo: oth.OdukNimSubStructure DescendantInfo: netw.LogicalQosConstrainedInterfaceCtp DescendantInfo: rtr.IpAddressLikeCtp DescendantInfo: rtr.VirtualInterfaceCtp DescendantIn...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"nodeId\": \"string\", \"ctpFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "ctpFilter", "nodeId" ], "properties": { "nodeId": { "type": "string", "description": " " }, "ctpFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findAvailableCtpsPerNode to decode json data to internal NFM-P object model" } } ], "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": "/restNetwConnectionTerminationPointFindAvailableCtpsPerNode" }, "task": true }, { "name": "restNetwConnectionTerminationPointFindAvailableNetworkCtpsPerNode", "summary": "findAvailableNetworkCtpsPerNode", "description": "Intention : RETRIEVER findAvailableNetworkCtpsPerNode: class-level [object finder] (retriever) API findAvailableNetworkCtpsPerNode of class netw.ConnectionTerminationPoint DescendantInfo: opticalequipment.EthernetCtp DescendantInfo: tdm.AUn DescendantInfo: oth.OdukPtf DescendantInfo: optical.Odu1PtfChannel DescendantInfo: oth.OdukNimSubStructure DescendantInfo: netw.LogicalQosConstrainedInterfaceCtp DescendantInfo: rtr.IpAddressLikeCtp DescendantInfo: rtr.VirtualInterfaceCtp...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"nodeId\": \"string\", \"ctpFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "ctpFilter", "nodeId" ], "properties": { "nodeId": { "type": "string", "description": " " }, "ctpFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findAvailableNetworkCtpsPerNode to decode json data to internal NFM-P object model" } } ], "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": "/restNetwConnectionTerminationPointFindAvailableNetworkCtpsPerNode" }, "task": true }, { "name": "restNetwConnectionTerminationPointFindCtp", "summary": "findCtp", "description": "Intention : RETRIEVER findCtp: class-level [object finder] (retriever) API findCtp of class netw.ConnectionTerminationPoint DescendantInfo: opticalequipment.EthernetCtp DescendantInfo: tdm.AUn DescendantInfo: oth.OdukPtf DescendantInfo: optical.Odu1PtfChannel DescendantInfo: oth.OdukNimSubStructure DescendantInfo: netw.LogicalQosConstrainedInterfaceCtp DescendantInfo: rtr.IpAddressLikeCtp DescendantInfo: rtr.VirtualInterfaceCtp DescendantInfo: netw.PhysicalInterfaceCtp De...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"portObjectPointer\": \"string\", \"ctpFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "ctpFilter", "portObjectPointer" ], "properties": { "portObjectPointer": { "type": "string", "description": " " }, "ctpFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findCtp to decode json data to internal NFM-P object model" } } ], "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": "/restNetwConnectionTerminationPointFindCtp" }, "task": true }, { "name": "restNetwConnectionTerminationPointFindCtpFiltered", "summary": "findCtpFiltered", "description": "Intention : RETRIEVER findCtpFiltered: class-level [object finder] (retriever) API findCtpFiltered of class netw.ConnectionTerminationPoint DescendantInfo: opticalequipment.EthernetCtp DescendantInfo: tdm.AUn DescendantInfo: oth.OdukPtf DescendantInfo: optical.Odu1PtfChannel DescendantInfo: oth.OdukNimSubStructure DescendantInfo: netw.LogicalQosConstrainedInterfaceCtp DescendantInfo: rtr.IpAddressLikeCtp DescendantInfo: rtr.VirtualInterfaceCtp DescendantInfo: netw.Physical...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restNetwConnectionTerminationPointFindCtpFiltered" }, "task": true }, { "name": "restNetwConnectionTerminationPointFindCtpsOnDirectlyTerminatablePort", "summary": "findCtpsOnDirectlyTerminatablePort", "description": "Intention : RETRIEVER findCtpsOnDirectlyTerminatablePort: class-level [object finder] (retriever) API findCtpsOnDirectlyTerminatablePort of class netw.ConnectionTerminationPoint DescendantInfo: opticalequipment.EthernetCtp DescendantInfo: tdm.AUn DescendantInfo: oth.OdukPtf DescendantInfo: optical.Odu1PtfChannel DescendantInfo: oth.OdukNimSubStructure DescendantInfo: netw.LogicalQosConstrainedInterfaceCtp DescendantInfo: rtr.IpAddressLikeCtp DescendantInfo: rtr.VirtualInterf...(description truncated)", "input": [ { "name": "portObjectPointer", "type": "string", "info": ": string", "required": false, "schema": { "title": "portObjectPointer", "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": "/restNetwConnectionTerminationPointFindCtpsOnDirectlyTerminatablePort" }, "task": true }, { "name": "restNetwConnectionTerminationPointFindCtpsOnMultiplePorts", "summary": "findCtpsOnMultiplePorts", "description": "Intention : RETRIEVER findCtpsOnMultiplePorts: class-level [object finder] (retriever) API findCtpsOnMultiplePorts of class netw.ConnectionTerminationPoint DescendantInfo: opticalequipment.EthernetCtp DescendantInfo: tdm.AUn DescendantInfo: oth.OdukPtf DescendantInfo: optical.Odu1PtfChannel DescendantInfo: oth.OdukNimSubStructure DescendantInfo: netw.LogicalQosConstrainedInterfaceCtp DescendantInfo: rtr.IpAddressLikeCtp DescendantInfo: rtr.VirtualInterfaceCtp DescendantInfo...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"portObjectPointers\": \"array\", \"ctpFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "ctpFilter", "portObjectPointers" ], "properties": { "portObjectPointers": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "ctpFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findCtpsOnMultiplePorts to decode json data to internal NFM-P object model" } } ], "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": "/restNetwConnectionTerminationPointFindCtpsOnMultiplePorts" }, "task": true }, { "name": "restNetwConnectionTerminationPointFindCtpsOnMultiplePortsWithFilter", "summary": "findCtpsOnMultiplePortsWithFilter", "description": "Intention : RETRIEVER findCtpsOnMultiplePortsWithFilter: class-level [object finder] (retriever) API findCtpsOnMultiplePortsWithFilter of class netw.ConnectionTerminationPoint DescendantInfo: opticalequipment.EthernetCtp DescendantInfo: tdm.AUn DescendantInfo: oth.OdukPtf DescendantInfo: optical.Odu1PtfChannel DescendantInfo: oth.OdukNimSubStructure DescendantInfo: netw.LogicalQosConstrainedInterfaceCtp DescendantInfo: rtr.IpAddressLikeCtp DescendantInfo: rtr.VirtualInterfac...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"portObjectFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"ctpFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "ctpFilter", "portObjectFilter" ], "properties": { "portObjectFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "ctpFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findCtpsOnMultiplePortsWithFilter to decode json data to internal NFM-P object model" } } ], "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": "/restNetwConnectionTerminationPointFindCtpsOnMultiplePortsWithFilter" }, "task": true }, { "name": "restNetwDiscoveredPhysicalLinkCleanUpReference", "summary": "rest_netw_DiscoveredPhysicalLink_cleanUpReference", "description": "rest_netw_DiscoveredPhysicalLink_cleanUpReference", "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": "/restNetwDiscoveredPhysicalLinkCleanUpReference" }, "task": true }, { "name": "restNetwDiscoveredPhysicalLinkCleanUpReferenceInTopologyGroup", "summary": "rest_netw_DiscoveredPhysicalLink_cleanUpReferenceInTopologyGroup", "description": "rest_netw_DiscoveredPhysicalLink_cleanUpReferenceInTopologyGroup", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restNetwDiscoveredPhysicalLinkCleanUpReferenceInTopologyGroup" }, "task": true }, { "name": "restNetwDiscoveredPhysicalLinkCleanUpReferenceSelected", "summary": "rest_netw_DiscoveredPhysicalLink_cleanUpReferenceSelected", "description": "rest_netw_DiscoveredPhysicalLink_cleanUpReferenceSelected", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNetwDiscoveredPhysicalLinkCleanUpReferenceSelected" }, "task": true }, { "name": "restNetwDiscoveredPhysicalLinkClearReference", "summary": "rest_netw_DiscoveredPhysicalLink_clearReference", "description": "rest_netw_DiscoveredPhysicalLink_clearReference", "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": "/restNetwDiscoveredPhysicalLinkClearReference" }, "task": true }, { "name": "restNetwDiscoveredPhysicalLinkClearReferenceInTopologyGroup", "summary": "rest_netw_DiscoveredPhysicalLink_clearReferenceInTopologyGroup", "description": "rest_netw_DiscoveredPhysicalLink_clearReferenceInTopologyGroup", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restNetwDiscoveredPhysicalLinkClearReferenceInTopologyGroup" }, "task": true }, { "name": "restNetwDiscoveredPhysicalLinkClearReferenceSelected", "summary": "rest_netw_DiscoveredPhysicalLink_clearReferenceSelected", "description": "rest_netw_DiscoveredPhysicalLink_clearReferenceSelected", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNetwDiscoveredPhysicalLinkClearReferenceSelected" }, "task": true }, { "name": "restNetwDiscoveredPhysicalLinkDeleteDuplicatePhysicalLinks", "summary": "rest_netw_DiscoveredPhysicalLink_deleteDuplicatePhysicalLinks", "description": "rest_netw_DiscoveredPhysicalLink_deleteDuplicatePhysicalLinks", "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": "/restNetwDiscoveredPhysicalLinkDeleteDuplicatePhysicalLinks" }, "task": true }, { "name": "restNetwDiscoveredPhysicalLinkSetReference", "summary": "rest_netw_DiscoveredPhysicalLink_setReference", "description": "rest_netw_DiscoveredPhysicalLink_setReference", "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": "/restNetwDiscoveredPhysicalLinkSetReference" }, "task": true }, { "name": "restNetwDiscoveredPhysicalLinkSetReferenceInTopologyGroup", "summary": "rest_netw_DiscoveredPhysicalLink_setReferenceInTopologyGroup", "description": "rest_netw_DiscoveredPhysicalLink_setReferenceInTopologyGroup", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restNetwDiscoveredPhysicalLinkSetReferenceInTopologyGroup" }, "task": true }, { "name": "restNetwDiscoveredPhysicalLinkSetReferenceSelected", "summary": "rest_netw_DiscoveredPhysicalLink_setReferenceSelected", "description": "rest_netw_DiscoveredPhysicalLink_setReferenceSelected", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNetwDiscoveredPhysicalLinkSetReferenceSelected" }, "task": true }, { "name": "restNetwGroupAddNetworkElementsToGroup", "summary": "addNetworkElementsToGroup", "description": "Adds a new NE to an existing group. Intention : MODIFIER addNetworkElementsToGroup: instance-level modifier API addNetworkElementsToGroup of class netw.Group DescendantInfo: netw.VlanGroup DescendantInfo: netw.SimpleGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNetwGroupAddNetworkElementsToGroup" }, "task": true }, { "name": "restNetwGroupConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class netw.Group This API follows hierarchical config model rules. DescendantInfo: netw.VlanGroup DescendantInfo: netw.SimpleGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restNetwGroupConfigure" }, "task": true }, { "name": "restNetwGroupFindGroupBindings", "summary": "findGroupBindings", "description": "Intention : RETRIEVER findGroupBindings: instance-level [object finder] (retriever) API findGroupBindings of class netw.Group DescendantInfo: netw.VlanGroup DescendantInfo: netw.SimpleGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restNetwGroupFindGroupBindings" }, "task": true }, { "name": "restNetwGroupFindNetworkElementsAssignableToGroup", "summary": "findNetworkElementsAssignableToGroup", "description": "Intention : RETRIEVER findNetworkElementsAssignableToGroup: instance-level [object finder] (retriever) API findNetworkElementsAssignableToGroup of class netw.Group DescendantInfo: netw.VlanGroup DescendantInfo: netw.SimpleGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "aInMultiGroupAllowed", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "aInMultiGroupAllowed", "type": "boolean" } }, { "name": "aInGroupMode", "type": "number", "info": ": 123", "required": false, "schema": { "title": "aInGroupMode", "type": "number" } }, { "name": "aInHeadEnds", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "aInHeadEnds", "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": "/restNetwGroupFindNetworkElementsAssignableToGroup" }, "task": true }, { "name": "restNetwGroupFindNetworkElementsInGroup", "summary": "findNetworkElementsInGroup", "description": "Intention : RETRIEVER findNetworkElementsInGroup: instance-level [object finder] (retriever) API findNetworkElementsInGroup of class netw.Group DescendantInfo: netw.VlanGroup DescendantInfo: netw.SimpleGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restNetwGroupFindNetworkElementsInGroup" }, "task": true }, { "name": "restNetwGroupRemoveNetworkElementsFromGroup", "summary": "removeNetworkElementsFromGroup", "description": "Removes a NE from an existing group. Intention : MODIFIER removeNetworkElementsFromGroup: instance-level [administrative deletion] (modifier) API removeNetworkElementsFromGroup of class netw.Group DescendantInfo: netw.VlanGroup DescendantInfo: netw.SimpleGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNetwGroupRemoveNetworkElementsFromGroup" }, "task": true }, { "name": "restNetwGroupBindingConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class netw.GroupBinding This API follows hierarchical config model rules. DescendantInfo: netw.VlanGroupBinding DescendantInfo: netw.SimpleGroupBinding instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restNetwGroupBindingConfigure" }, "task": true }, { "name": "restNetwGroupDirectorFindGroupsContainingObject", "summary": "findGroupsContainingObject", "description": "Intention : RETRIEVER findGroupsContainingObject: class-level [object finder] (retriever) API findGroupsContainingObject on default instance groups of class netw.GroupDirector", "input": [ { "name": "body", "type": "object", "info": ": {\"aInObjectFullName\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter" ], "properties": { "aInObjectFullName": { "type": "string" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for GroupDirector.findGroupsContainingObject to decode json data to internal NFM-P object model" } } ], "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": "/restNetwGroupDirectorFindGroupsContainingObject" }, "task": true }, { "name": "restNetwGroupManagerConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class netw.GroupManager This API follows hierarchical config model rules. DescendantInfo: netw.VlanGroupManager instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restNetwGroupManagerConfigure" }, "task": true }, { "name": "restNetwGroupManagerFindCandidateGroupsForNewMembers", "summary": "findCandidateGroupsForNewMembers", "description": "Intention : RETRIEVER findCandidateGroupsForNewMembers: instance-level [object finder] (retriever) API findCandidateGroupsForNewMembers of class netw.GroupManager DescendantInfo: netw.VlanGroupManager instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNetwGroupManagerFindCandidateGroupsForNewMembers" }, "task": true }, { "name": "restNetwGroupManagerFindGroups", "summary": "findGroups", "description": "Intention : RETRIEVER findGroups: instance-level [object finder] (retriever) API findGroups of class netw.GroupManager DescendantInfo: netw.VlanGroupManager instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restNetwGroupManagerFindGroups" }, "task": true }, { "name": "restNetwGroupManagerFindNonMembers", "summary": "findNonMembers", "description": "Intention : RETRIEVER findNonMembers: instance-level [object finder] (retriever) API findNonMembers of class netw.GroupManager DescendantInfo: netw.VlanGroupManager instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInObjectClassName\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter" ], "properties": { "aInObjectClassName": { "type": "string" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for GroupManager.findNonMembers to decode json data to internal NFM-P object model" } } ], "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": "/restNetwGroupManagerFindNonMembers" }, "task": true }, { "name": "restNetwNeStubDiscover", "summary": "rest_netw_NeStub_discover", "description": "rest_netw_NeStub_discover", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNeStubDiscover" }, "task": true }, { "name": "restNetwNetworkRemoveNe", "summary": "rest_netw_Network_removeNe", "description": "rest_netw_Network_removeNe", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restNetwNetworkRemoveNe" }, "task": true }, { "name": "restNetwNetworkElementAssociatePeerNode", "summary": "rest_netw_NetworkElement_associatePeerNode", "description": "rest_netw_NetworkElement_associatePeerNode", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restNetwNetworkElementAssociatePeerNode" }, "task": true }, { "name": "restNetwNetworkElementCleanUpInconsistenciesOnNode", "summary": "rest_netw_NetworkElement_cleanUpInconsistenciesOnNode", "description": "rest_netw_NetworkElement_cleanUpInconsistenciesOnNode", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementCleanUpInconsistenciesOnNode" }, "task": true }, { "name": "restNetwNetworkElementColdReboot", "summary": "rest_netw_NetworkElement_coldReboot", "description": "rest_netw_NetworkElement_coldReboot", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementColdReboot" }, "task": true }, { "name": "restNetwNetworkElementConnectToConsole", "summary": "connectToConsole", "description": "Intention : MODIFIER connectToConsole: instance-level modifier API connectToConsole of class netw.NetworkElement instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementConnectToConsole" }, "task": true }, { "name": "restNetwNetworkElementDissociatePeerNode", "summary": "rest_netw_NetworkElement_dissociatePeerNode", "description": "rest_netw_NetworkElement_dissociatePeerNode", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementDissociatePeerNode" }, "task": true }, { "name": "restNetwNetworkElementDoInconsistenciesExistOnNode", "summary": "doInconsistenciesExistOnNode", "description": "Intention : RETRIEVER doInconsistenciesExistOnNode: instance-level retriever API doInconsistenciesExistOnNode of class netw.NetworkElement instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementDoInconsistenciesExistOnNode" }, "task": true }, { "name": "restNetwNetworkElementExecuteCli", "summary": "executeCli", "description": "Execute a single raw CLI command on this Network Element. Intention : RETRIEVER executeCli: instance-level retriever API executeCli of class netw.NetworkElement instanceFullName : distinguished/instance name of called object Any output that was generated by the NE as a result of the command.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restNetwNetworkElementExecuteCli" }, "task": true }, { "name": "restNetwNetworkElementExecuteMultiCli", "summary": "executeMultiCli", "description": "Execute multiple CLI commands on this Network Element. Intention : RETRIEVER executeMultiCli: instance-level retriever API executeMultiCli of class netw.NetworkElement instanceFullName : distinguished/instance name of called object Any output that was generated by the NE as a result of the commands.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNetwNetworkElementExecuteMultiCli" }, "task": true }, { "name": "restNetwNetworkElementFullResync", "summary": "rest_netw_NetworkElement_fullResync", "description": "rest_netw_NetworkElement_fullResync", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementFullResync" }, "task": true }, { "name": "restNetwNetworkElementFullResyncMulti", "summary": "rest_netw_NetworkElement_fullResyncMulti", "description": "rest_netw_NetworkElement_fullResyncMulti", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNetwNetworkElementFullResyncMulti" }, "task": true }, { "name": "restNetwNetworkElementGetSearchResult", "summary": "getSearchResult", "description": "Intention : RETRIEVER getSearchResult: instance-level retriever API getSearchResult of class netw.NetworkElement instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "aInXmlSearchCmd", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInXmlSearchCmd", "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": "/restNetwNetworkElementGetSearchResult" }, "task": true }, { "name": "restNetwNetworkElementGetSearchSuggestionCache", "summary": "getSearchSuggestionCache", "description": "Intention : RETRIEVER getSearchSuggestionCache: instance-level retriever API getSearchSuggestionCache of class netw.NetworkElement instanceFullName : distinguished/instance name of called object A map of attribute list by classname.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "aInDeprecatedEnable", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "aInDeprecatedEnable", "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": "/restNetwNetworkElementGetSearchSuggestionCache" }, "task": true }, { "name": "restNetwNetworkElementReconfigure", "summary": "rest_netw_NetworkElement_reconfigure", "description": "rest_netw_NetworkElement_reconfigure", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementReconfigure" }, "task": true }, { "name": "restNetwNetworkElementReconfigureMulti", "summary": "rest_netw_NetworkElement_reconfigureMulti", "description": "rest_netw_NetworkElement_reconfigureMulti", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNetwNetworkElementReconfigureMulti" }, "task": true }, { "name": "restNetwNetworkElementRegisterHDMDashboard", "summary": "rest_netw_NetworkElement_registerHDMDashboard", "description": "rest_netw_NetworkElement_registerHDMDashboard", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementRegisterHDMDashboard" }, "task": true }, { "name": "restNetwNetworkElementRequestClearSystemStatsDataTrigger", "summary": "requestClearSystemStatsDataTrigger", "description": "Request clearing of Data-Triggered Subscriber Host Stats with the specified parameters. The siteId is required. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearSystemStatsDataTrigger: class-level modifier API requestClearSystemStatsDataTrigger of c...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "objectClassName", "siteId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" } }, "description": "Model containing the method level model for struct ClearSystemStatsDataTriggerStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restNetwNetworkElementRequestClearSystemStatsDataTrigger" }, "task": true }, { "name": "restNetwNetworkElementRequestResyncCfmComponentLimit", "summary": "rest_netw_NetworkElement_requestResyncCfmComponentLimit", "description": "rest_netw_NetworkElement_requestResyncCfmComponentLimit", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementRequestResyncCfmComponentLimit" }, "task": true }, { "name": "restNetwNetworkElementRequestResyncCfmGlobalOpcode", "summary": "rest_netw_NetworkElement_requestResyncCfmGlobalOpcode", "description": "rest_netw_NetworkElement_requestResyncCfmGlobalOpcode", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementRequestResyncCfmGlobalOpcode" }, "task": true }, { "name": "restNetwNetworkElementRequestResyncOamPerfReqTypes", "summary": "rest_netw_NetworkElement_requestResyncOamPerfReqTypes", "description": "rest_netw_NetworkElement_requestResyncOamPerfReqTypes", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementRequestResyncOamPerfReqTypes" }, "task": true }, { "name": "restNetwNetworkElementRequestResyncTwampSrvSessions", "summary": "rest_netw_NetworkElement_requestResyncTwampSrvSessions", "description": "rest_netw_NetworkElement_requestResyncTwampSrvSessions", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementRequestResyncTwampSrvSessions" }, "task": true }, { "name": "restNetwNetworkElementRequestSavePythonScript", "summary": "rest_netw_NetworkElement_requestSavePythonScript", "description": "rest_netw_NetworkElement_requestSavePythonScript", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInpythonProtectFileUrl\": \"string\", \"aInpythonProtectDestFileUrl\": \"string\", \"aInpythonProtectType\": \"string\", \"aInpythonProtectKey\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInpythonProtectFileUrl": { "type": "string" }, "aInpythonProtectDestFileUrl": { "type": "string" }, "aInpythonProtectType": { "type": "string" }, "aInpythonProtectKey": { "type": "string" } }, "description": "Model containing the method level model for NetworkElement.requestSavePythonScript to decode json data to internal NFM-P object model" } } ], "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": "/restNetwNetworkElementRequestSavePythonScript" }, "task": true }, { "name": "restNetwNetworkElementResyncDetNatScript", "summary": "rest_netw_NetworkElement_resyncDetNatScript", "description": "rest_netw_NetworkElement_resyncDetNatScript", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementResyncDetNatScript" }, "task": true }, { "name": "restNetwNetworkElementSaveDetNatScript", "summary": "rest_netw_NetworkElement_saveDetNatScript", "description": "rest_netw_NetworkElement_saveDetNatScript", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementSaveDetNatScript" }, "task": true }, { "name": "restNetwNetworkElementSetToActive", "summary": "rest_netw_NetworkElement_setToActive", "description": "rest_netw_NetworkElement_setToActive", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementSetToActive" }, "task": true }, { "name": "restNetwNetworkElementSetToStandby", "summary": "rest_netw_NetworkElement_setToStandby", "description": "rest_netw_NetworkElement_setToStandby", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementSetToStandby" }, "task": true }, { "name": "restNetwNetworkElementSynchronizeACL", "summary": "rest_netw_NetworkElement_synchronizeACL", "description": "rest_netw_NetworkElement_synchronizeACL", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementSynchronizeACL" }, "task": true }, { "name": "restNetwNetworkElementUnregisterHDMDashboard", "summary": "rest_netw_NetworkElement_unregisterHDMDashboard", "description": "rest_netw_NetworkElement_unregisterHDMDashboard", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementUnregisterHDMDashboard" }, "task": true }, { "name": "restNetwNetworkElementUpdateFromPeerNode", "summary": "rest_netw_NetworkElement_updateFromPeerNode", "description": "rest_netw_NetworkElement_updateFromPeerNode", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementUpdateFromPeerNode" }, "task": true }, { "name": "restNetwNetworkElementWarmReboot", "summary": "rest_netw_NetworkElement_warmReboot", "description": "rest_netw_NetworkElement_warmReboot", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwNetworkElementWarmReboot" }, "task": true }, { "name": "restNetwNodeDiscoveryControlPing", "summary": "rest_netw_NodeDiscoveryControl_ping", "description": "rest_netw_NodeDiscoveryControl_ping", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restNetwNodeDiscoveryControlPing" }, "task": true }, { "name": "restNetwNodeDiscoveryControlPingAndGetResult", "summary": "pingAndGetResult", "description": "Execute network element reachability test based on network element management connection type and return the ping status enum {{mediation.PingStatus}}. It waits for the result and then returns so there may be delay due to network or timeout. Intention : RETRIEVER pingAndGetResult: instance-level retriever API pingAndGetResult of class netw.NodeDiscoveryControl instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restNetwNodeDiscoveryControlPingAndGetResult" }, "task": true }, { "name": "restNetwPhysicalInterfaceCtpFindServiceReadyCtpsPerNode", "summary": "findServiceReadyCtpsPerNode", "description": "Intention : RETRIEVER findServiceReadyCtpsPerNode: class-level [object finder] (retriever) API findServiceReadyCtpsPerNode of class netw.PhysicalInterfaceCtp", "input": [ { "name": "body", "type": "object", "info": ": {\"nodeId\": \"string\", \"ctpFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"serviceType\": 123}", "required": false, "schema": { "type": "object", "required": [ "ctpFilter", "nodeId", "serviceType" ], "properties": { "nodeId": { "type": "string", "description": " " }, "ctpFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "serviceType": { "type": "integer", "description": " " } }, "description": "Model containing the method level model for PhysicalInterfaceCtp.findServiceReadyCtpsPerNode to decode json data to internal NFM-P object model" } } ], "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": "/restNetwPhysicalInterfaceCtpFindServiceReadyCtpsPerNode" }, "task": true }, { "name": "restNetwSystemOperGroupFindMeps", "summary": "findMeps", "description": "Intention : RETRIEVER findMeps: instance-level [object finder] (retriever) API findMeps of class netw.SystemOperGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwSystemOperGroupFindMeps" }, "task": true }, { "name": "restNetwSystemOperGroupFindPorts", "summary": "findPorts", "description": "Intention : RETRIEVER findPorts: instance-level [object finder] (retriever) API findPorts of class netw.SystemOperGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwSystemOperGroupFindPorts" }, "task": true }, { "name": "restNetwTopologyConfigureDiscoveryRule", "summary": "configureDiscoveryRule", "description": "Intention : MODIFIER configureDiscoveryRule: instance-level [hierarchical administrative configuration/modification] (modifier) API configureDiscoveryRule on default instance network:topology of class netw.Topology This API follows hierarchical config model rules.", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"id\": 123, \"description\": \"string\", \"administrativeState\": 123, \"readMediationPolicyId\": 123, \"writeMediationPolicyId\": 123, \"trapMediationPolicyId\": 123, \"securityMediationPolicyId\": 123, \"dualReadMediationPolicyId\": 123, \"dualWriteMediationPolicyId\": 123, \"dualTrapMediationPolicyId\": 123, \"outOfBandPingPolicyId\": 123, \"inBandPingPolicyId\": 123, \"standbyCpmPingPolicyId\": 123, \"statsPollingPolicyId\": 123, \"olcState\": 123, \"revertOlcState\": \"boolean\", \"scanInterval\": 123, \"backupPolicyPointer\": \"string\", \"topologyGroupPointer\": \"string\", \"ipAddressType\": 123, \"neSelfConfigurationPolicies\": \"array\", \"defaultExternalEms\": \"string\", \"podPointer\": \"string\", \"dcInterconnectPointer\": \"string\", \"postDiscoveryActionPointer\": \"string\", \"discoveryProtocol\": 123}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "id": { "type": "integer" }, "description": { "type": "string" }, "administrativeState": { "type": "integer" }, "readMediationPolicyId": { "type": "integer" }, "writeMediationPolicyId": { "type": "integer" }, "trapMediationPolicyId": { "type": "integer" }, "securityMediationPolicyId": { "type": "integer" }, "dualReadMediationPolicyId": { "type": "integer" }, "dualWriteMediationPolicyId": { "type": "integer" }, "dualTrapMediationPolicyId": { "type": "integer" }, "outOfBandPingPolicyId": { "type": "integer" }, "inBandPingPolicyId": { "type": "integer" }, "standbyCpmPingPolicyId": { "type": "integer" }, "statsPollingPolicyId": { "type": "integer" }, "olcState": { "type": "integer" }, "revertOlcState": { "type": "boolean", "default": false }, "scanInterval": { "type": "integer" }, "backupPolicyPointer": { "type": "string" }, "topologyGroupPointer": { "type": "string" }, "ipAddressType": { "type": "integer" }, "neSelfConfigurationPolicies": { "type": "array", "items": { "type": "string" } }, "defaultExternalEms": { "type": "string" }, "podPointer": { "type": "string" }, "dcInterconnectPointer": { "type": "string" }, "postDiscoveryActionPointer": { "type": "string" }, "discoveryProtocol": { "type": "integer" } }, "description": "Model containing the method level model for Interface ConfigInfo TopologyDiscoveryRuleConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restNetwTopologyConfigureDiscoveryRule" }, "task": true }, { "name": "restNetwTopologyFindUnDiscoveredNodes", "summary": "findUnDiscoveredNodes", "description": "Finds nodes within a set of discovery rules that have not been discovered. Intention : RETRIEVER findUnDiscoveredNodes: instance-level [object finder] (retriever) API findUnDiscoveredNodes on default instance network:topology of class netw.Topology List of Mgmt IP addresses corresponding to the nodes in all specified discovery rule instances that have not been discovered.", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNetwTopologyFindUnDiscoveredNodes" }, "task": true }, { "name": "restNetwTopologyDiscoveryRuleAssignNodes", "summary": "rest_netw_TopologyDiscoveryRule_assignNodes", "description": "rest_netw_TopologyDiscoveryRule_assignNodes", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNetwTopologyDiscoveryRuleAssignNodes" }, "task": true }, { "name": "restNetwTopologyDiscoveryRuleConfigureRuleElement", "summary": "configureRuleElement", "description": "Intention : MODIFIER configureRuleElement: instance-level [hierarchical administrative configuration/modification] (modifier) API configureRuleElement of class netw.TopologyDiscoveryRule This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"ipAddressType\": 123, \"ipAddress\": \"string\", \"maskBits\": 123, \"usage\": 123}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "ipAddressType": { "type": "integer" }, "ipAddress": { "type": "string" }, "maskBits": { "type": "integer" }, "usage": { "type": "integer" } }, "description": "Model containing the method level model for Interface ConfigInfo TopologyDiscoveryRuleElementConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restNetwTopologyDiscoveryRuleConfigureRuleElement" }, "task": true }, { "name": "restNetwTopologyDiscoveryRuleFindDiscoveredNodes", "summary": "findDiscoveredNodes", "description": "Finds nodes within this discovery rule that have been discovered. Intention : RETRIEVER findDiscoveredNodes: instance-level [object finder] (retriever) API findDiscoveredNodes of class netw.TopologyDiscoveryRule instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwTopologyDiscoveryRuleFindDiscoveredNodes" }, "task": true }, { "name": "restNetwTopologyDiscoveryRuleFindUnDiscoveredNodes", "summary": "findUnDiscoveredNodes", "description": "Finds nodes within this discovery rule that have not been discovered. Intention : RETRIEVER findUnDiscoveredNodes: instance-level [object finder] (retriever) API findUnDiscoveredNodes of class netw.TopologyDiscoveryRule instanceFullName : distinguished/instance name of called object List of Mgmt IP addresses corresponding to the nodes in the specified discovery rule instance that have not been discovered.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwTopologyDiscoveryRuleFindUnDiscoveredNodes" }, "task": true }, { "name": "restNetwTopologyDiscoveryRuleForce", "summary": "rest_netw_TopologyDiscoveryRule_force", "description": "rest_netw_TopologyDiscoveryRule_force", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwTopologyDiscoveryRuleForce" }, "task": true }, { "name": "restNetwTopologyGroupDeleteTopologyGroupAndBindings", "summary": "rest_netw_TopologyGroup_deleteTopologyGroupAndBindings", "description": "rest_netw_TopologyGroup_deleteTopologyGroupAndBindings", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restNetwTopologyGroupDeleteTopologyGroupAndBindings" }, "task": true }, { "name": "restNetwTopologyGroupGetBindingsForTopologyGroup", "summary": "getBindingsForTopologyGroup", "description": "Intention : RETRIEVER getBindingsForTopologyGroup: class-level retriever API getBindingsForTopologyGroup of class netw.TopologyGroup", "input": [ { "name": "topologyGroupName", "type": "string", "info": ": string", "required": false, "schema": { "title": "topologyGroupName", "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": "/restNetwTopologyGroupGetBindingsForTopologyGroup" }, "task": true }, { "name": "restNetwTopologyGroupManagerConfigureTopologyGroup", "summary": "configureTopologyGroup", "description": "Intention : MODIFIER configureTopologyGroup: instance-level [hierarchical administrative configuration/modification] (modifier) API configureTopologyGroup on default instance topologyGroup of class netw.TopologyGroupManager This API follows hierarchical config model rules.", "input": [ { "name": "body", "type": "object", "info": ": {\"parentGroupName\": \"string\", \"parentViewName\": \"string\", \"topologyGroupInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\"}}", "required": false, "schema": { "type": "object", "required": [ "parentGroupName", "parentViewName", "topologyGroupInfo" ], "properties": { "parentGroupName": { "type": "string", "description": " " }, "parentViewName": { "type": "string", "description": " " }, "topologyGroupInfo": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for TopologyGroupManager.configureTopologyGroup to decode json data to internal NFM-P object model" } } ], "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": "/restNetwTopologyGroupManagerConfigureTopologyGroup" }, "task": true }, { "name": "restNetwTopologyGroupManagerCreateTopologyGroupBindingForObject", "summary": "rest_netw_TopologyGroupManager_createTopologyGroupBindingForObject", "description": "rest_netw_TopologyGroupManager_createTopologyGroupBindingForObject", "input": [ { "name": "body", "type": "object", "info": ": {\"xCoordinate\": 123, \"yCoordinate\": 123, \"parentGroupFullName\": \"string\", \"objectFullName\": \"string\", \"label\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "label", "objectFullName", "parentGroupFullName" ], "properties": { "xCoordinate": { "type": "integer" }, "yCoordinate": { "type": "integer" }, "parentGroupFullName": { "type": "string", "description": " " }, "objectFullName": { "type": "string", "description": " " }, "label": { "type": "string", "description": " " } }, "description": "Model containing the method level model for TopologyGroupManager.createTopologyGroupBindingForObject to decode json data to internal NFM-P object model" } } ], "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": "/restNetwTopologyGroupManagerCreateTopologyGroupBindingForObject" }, "task": true }, { "name": "restNetwTopologyGroupManagerGetNesAndSubgroupsForTopologyGroup", "summary": "getNesAndSubgroupsForTopologyGroup", "description": "Intention : RETRIEVER getNesAndSubgroupsForTopologyGroup: class-level retriever API getNesAndSubgroupsForTopologyGroup on default instance topologyGroup of class netw.TopologyGroupManager", "input": [ { "name": "topologyGroupName", "type": "string", "info": ": string", "required": false, "schema": { "title": "topologyGroupName", "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": "/restNetwTopologyGroupManagerGetNesAndSubgroupsForTopologyGroup" }, "task": true }, { "name": "restNetwTopologyGroupManagerMoveTopologyGroupForObjects", "summary": "rest_netw_TopologyGroupManager_moveTopologyGroupForObjects", "description": "rest_netw_TopologyGroupManager_moveTopologyGroupForObjects", "input": [ { "name": "body", "type": "object", "info": ": {\"moveObjectNames\": \"array\", \"sourceGroupName\": \"string\", \"destinationGroupName\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "destinationGroupName", "moveObjectNames", "sourceGroupName" ], "properties": { "moveObjectNames": { "type": "array", "description": " ", "items": { "type": "string" } }, "sourceGroupName": { "type": "string", "description": " " }, "destinationGroupName": { "type": "string", "description": " " } }, "description": "Model containing the method level model for TopologyGroupManager.moveTopologyGroupForObjects to decode json data to internal NFM-P object model" } } ], "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": "/restNetwTopologyGroupManagerMoveTopologyGroupForObjects" }, "task": true }, { "name": "restNetwVlanGroupAddLeafNode", "summary": "rest_netw_VlanGroup_addLeafNode", "description": "rest_netw_VlanGroup_addLeafNode", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restNetwVlanGroupAddLeafNode" }, "task": true }, { "name": "restNetwVlanGroupAutoL3VPNInit", "summary": "rest_netw_VlanGroup_autoL3VPNInit", "description": "rest_netw_VlanGroup_autoL3VPNInit", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwVlanGroupAutoL3VPNInit" }, "task": true }, { "name": "restNetwVlanGroupAutoMplsEnable", "summary": "rest_netw_VlanGroup_autoMplsEnable", "description": "rest_netw_VlanGroup_autoMplsEnable", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwVlanGroupAutoMplsEnable" }, "task": true }, { "name": "restNetwVlanGroupDynamicL3VPNInit", "summary": "rest_netw_VlanGroup_dynamicL3VPNInit", "description": "rest_netw_VlanGroup_dynamicL3VPNInit", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNetwVlanGroupDynamicL3VPNInit" }, "task": true }, { "name": "restNetwVlanGroupDynamicRemoveNodes", "summary": "rest_netw_VlanGroup_dynamicRemoveNodes", "description": "rest_netw_VlanGroup_dynamicRemoveNodes", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNetwVlanGroupDynamicRemoveNodes" }, "task": true }, { "name": "restNetwVlanGroupRemoveLeafNode", "summary": "rest_netw_VlanGroup_removeLeafNode", "description": "rest_netw_VlanGroup_removeLeafNode", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restNetwVlanGroupRemoveLeafNode" }, "task": true }, { "name": "restNetwVlanGroupRemoveNodes", "summary": "rest_netw_VlanGroup_removeNodes", "description": "rest_netw_VlanGroup_removeNodes", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNetwVlanGroupRemoveNodes" }, "task": true }, { "name": "restNfvVNFManagerDiscoverVnf", "summary": "discoverVnf", "description": "Checks if the VNF supplied is dicovered. If not it refreshes the cbam AP to find it. Intention : MODIFIER discoverVnf: instance-level modifier API discoverVnf of class nfv.VNFManager instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restNfvVNFManagerDiscoverVnf" }, "task": true }, { "name": "restNgeDomainConfigureDomainSites", "summary": "configureDomainSites", "description": "This method creates NGE Domain Site objects. Intention : MODIFIER configureDomainSites: instance-level [hierarchical administrative configuration/modification] (modifier) API configureDomainSites of class nge.Domain This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeDomainConfigureDomainSites" }, "task": true }, { "name": "restNgeDomainConfigureKeyGroupEthBindings", "summary": "configureKeyGroupEthBindings", "description": "This method creates Key Group L2 Ethernet Ports objects. Intention : MODIFIER configureKeyGroupEthBindings: instance-level [hierarchical administrative configuration/modification] (modifier) API configureKeyGroupEthBindings of class nge.Domain This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeDomainConfigureKeyGroupEthBindings" }, "task": true }, { "name": "restNgeDomainConfigureKeyGroupRIBindings", "summary": "configureKeyGroupRIBindings", "description": "This method creates Key Group L3 Router Interface objects. Intention : MODIFIER configureKeyGroupRIBindings: instance-level [hierarchical administrative configuration/modification] (modifier) API configureKeyGroupRIBindings of class nge.Domain This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeDomainConfigureKeyGroupRIBindings" }, "task": true }, { "name": "restNgeDomainDisableEthEncryption", "summary": "rest_nge_Domain_disableEthEncryption", "description": "rest_nge_Domain_disableEthEncryption", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeDomainDisableEthEncryption" }, "task": true }, { "name": "restNgeDomainDisableRIEncryption", "summary": "rest_nge_Domain_disableRIEncryption", "description": "rest_nge_Domain_disableRIEncryption", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeDomainDisableRIEncryption" }, "task": true }, { "name": "restNgeDomainEnableEthEncryption", "summary": "rest_nge_Domain_enableEthEncryption", "description": "rest_nge_Domain_enableEthEncryption", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeDomainEnableEthEncryption" }, "task": true }, { "name": "restNgeDomainEnableRIEncryption", "summary": "rest_nge_Domain_enableRIEncryption", "description": "rest_nge_Domain_enableRIEncryption", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeDomainEnableRIEncryption" }, "task": true }, { "name": "restNgeDomainNgeDiscoveryDomainSites", "summary": "rest_nge_Domain_ngeDiscoveryDomainSites", "description": "rest_nge_Domain_ngeDiscoveryDomainSites", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeDomainNgeDiscoveryDomainSites" }, "task": true }, { "name": "restNgeGatewayInterfaceFindGatewayInterfacesWithRiBinding", "summary": "findGatewayInterfacesWithRiBinding", "description": "NGE discovery multiple nodes Intention : MODIFIER findGatewayInterfacesWithRiBinding: instance-level [object finder] (modifier) API findGatewayInterfacesWithRiBinding of class nge.GatewayInterface instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeGatewayInterfaceFindGatewayInterfacesWithRiBinding" }, "task": true }, { "name": "restNgeGroupEncryptionLabelRemoveLocalGroupEncryptionLabels", "summary": "rest_nge_GroupEncryptionLabel_removeLocalGroupEncryptionLabels", "description": "rest_nge_GroupEncryptionLabel_removeLocalGroupEncryptionLabels", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeGroupEncryptionLabelRemoveLocalGroupEncryptionLabels" }, "task": true }, { "name": "restNgeKeyGroupConfigureKeyGroupPwBindings", "summary": "configureKeyGroupPwBindings", "description": "This method creates key group PW Template binding objects. Intention : MODIFIER configureKeyGroupPwBindings: instance-level [hierarchical administrative configuration/modification] (modifier) API configureKeyGroupPwBindings of class nge.KeyGroup This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeKeyGroupConfigureKeyGroupPwBindings" }, "task": true }, { "name": "restNgeKeyGroupConfigureKeyGroupSdpBindings", "summary": "configureKeyGroupSdpBindings", "description": "This method creates key group SDP binding objects. Intention : MODIFIER configureKeyGroupSdpBindings: instance-level [hierarchical administrative configuration/modification] (modifier) API configureKeyGroupSdpBindings of class nge.KeyGroup This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeKeyGroupConfigureKeyGroupSdpBindings" }, "task": true }, { "name": "restNgeKeyGroupConfigureKeyGroupWlanGwBindings", "summary": "configureKeyGroupWlanGwBindings", "description": "This method creates key group WLAN Gateway binding objects. Intention : MODIFIER configureKeyGroupWlanGwBindings: instance-level [hierarchical administrative configuration/modification] (modifier) API configureKeyGroupWlanGwBindings of class nge.KeyGroup This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeKeyGroupConfigureKeyGroupWlanGwBindings" }, "task": true }, { "name": "restNgeKeyGroupConfigureVprnEncryptionServices", "summary": "configureVprnEncryptionServices", "description": "This method creates key group VRF binding objects. Intention : MODIFIER configureVprnEncryptionServices: instance-level [hierarchical administrative configuration/modification] (modifier) API configureVprnEncryptionServices of class nge.KeyGroup This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeKeyGroupConfigureVprnEncryptionServices" }, "task": true }, { "name": "restNgeKeyGroupDisableDomainEthEncryption", "summary": "rest_nge_KeyGroup_disableDomainEthEncryption", "description": "rest_nge_KeyGroup_disableDomainEthEncryption", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeKeyGroupDisableDomainEthEncryption" }, "task": true }, { "name": "restNgeKeyGroupDisableDomainRIEncryption", "summary": "rest_nge_KeyGroup_disableDomainRIEncryption", "description": "rest_nge_KeyGroup_disableDomainRIEncryption", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeKeyGroupDisableDomainRIEncryption" }, "task": true }, { "name": "restNgeKeyGroupDisablePwEncryption", "summary": "rest_nge_KeyGroup_disablePwEncryption", "description": "rest_nge_KeyGroup_disablePwEncryption", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeKeyGroupDisablePwEncryption" }, "task": true }, { "name": "restNgeKeyGroupDisableSdpEncryption", "summary": "rest_nge_KeyGroup_disableSdpEncryption", "description": "rest_nge_KeyGroup_disableSdpEncryption", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeKeyGroupDisableSdpEncryption" }, "task": true }, { "name": "restNgeKeyGroupDisableVprnEncryption", "summary": "rest_nge_KeyGroup_disableVprnEncryption", "description": "rest_nge_KeyGroup_disableVprnEncryption", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeKeyGroupDisableVprnEncryption" }, "task": true }, { "name": "restNgeKeyGroupDisableWlanGwEncryption", "summary": "rest_nge_KeyGroup_disableWlanGwEncryption", "description": "rest_nge_KeyGroup_disableWlanGwEncryption", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeKeyGroupDisableWlanGwEncryption" }, "task": true }, { "name": "restNgeKeyGroupEnableDomainEthEncryption", "summary": "rest_nge_KeyGroup_enableDomainEthEncryption", "description": "rest_nge_KeyGroup_enableDomainEthEncryption", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeKeyGroupEnableDomainEthEncryption" }, "task": true }, { "name": "restNgeKeyGroupEnableDomainRIEncryption", "summary": "rest_nge_KeyGroup_enableDomainRIEncryption", "description": "rest_nge_KeyGroup_enableDomainRIEncryption", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeKeyGroupEnableDomainRIEncryption" }, "task": true }, { "name": "restNgeKeyGroupEnablePwEncryption", "summary": "rest_nge_KeyGroup_enablePwEncryption", "description": "rest_nge_KeyGroup_enablePwEncryption", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeKeyGroupEnablePwEncryption" }, "task": true }, { "name": "restNgeKeyGroupEnableSdpEncryption", "summary": "rest_nge_KeyGroup_enableSdpEncryption", "description": "rest_nge_KeyGroup_enableSdpEncryption", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeKeyGroupEnableSdpEncryption" }, "task": true }, { "name": "restNgeKeyGroupEnableVprnEncryption", "summary": "rest_nge_KeyGroup_enableVprnEncryption", "description": "rest_nge_KeyGroup_enableVprnEncryption", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeKeyGroupEnableVprnEncryption" }, "task": true }, { "name": "restNgeKeyGroupEnableWlanGwEncryption", "summary": "rest_nge_KeyGroup_enableWlanGwEncryption", "description": "rest_nge_KeyGroup_enableWlanGwEncryption", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeKeyGroupEnableWlanGwEncryption" }, "task": true }, { "name": "restNgeKeyGroupEncryptAll", "summary": "rest_nge_KeyGroup_encryptAll", "description": "rest_nge_KeyGroup_encryptAll", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNgeKeyGroupEncryptAll" }, "task": true }, { "name": "restNgeKeyGroupRemoveLocalKeyGroups", "summary": "rest_nge_KeyGroup_removeLocalKeyGroups", "description": "rest_nge_KeyGroup_removeLocalKeyGroups", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restNgeKeyGroupRemoveLocalKeyGroups" }, "task": true }, { "name": "restNgeNGEScheduledTaskGetRekeyProgressInfo", "summary": "getRekeyProgressInfo", "description": "Retrieve the rekey progress info. Intention : MODIFIER getRekeyProgressInfo: class-level modifier API getRekeyProgressInfo of class nge.NGEScheduledTask", "input": [ { "name": "ngeScheduledTaskFullName", "type": "string", "info": ": string", "required": false, "schema": { "title": "ngeScheduledTaskFullName", "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": "/restNgeNGEScheduledTaskGetRekeyProgressInfo" }, "task": true }, { "name": "restNgeNGEScheduledTaskResetRekeyTimes", "summary": "rest_nge_NGEScheduledTask_resetRekeyTimes", "description": "rest_nge_NGEScheduledTask_resetRekeyTimes", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNgeNGEScheduledTaskResetRekeyTimes" }, "task": true }, { "name": "restNgeNGEScheduledTaskStartManualRekey", "summary": "rest_nge_NGEScheduledTask_startManualRekey", "description": "rest_nge_NGEScheduledTask_startManualRekey", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInForceRekey\": \"boolean\", \"aInProgressiveRekey\": \"boolean\"}", "required": false, "schema": { "type": "object", "properties": { "aInForceRekey": { "type": "boolean", "default": false }, "aInProgressiveRekey": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for NGEScheduledTask.startManualRekey to decode json data to internal NFM-P object model" } } ], "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": "/restNgeNGEScheduledTaskStartManualRekey" }, "task": true }, { "name": "restNgeRekeyProgressForceRekey", "summary": "rest_nge_RekeyProgress_forceRekey", "description": "rest_nge_RekeyProgress_forceRekey", "input": [ { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restNgeRekeyProgressForceRekey" }, "task": true }, { "name": "restNgeRekeyProgressRefreshInfo", "summary": "rest_nge_RekeyProgress_refreshInfo", "description": "rest_nge_RekeyProgress_refreshInfo", "input": [ { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restNgeRekeyProgressRefreshInfo" }, "task": true }, { "name": "restNgeRekeyProgressStopRekey", "summary": "rest_nge_RekeyProgress_stopRekey", "description": "rest_nge_RekeyProgress_stopRekey", "input": [ { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restNgeRekeyProgressStopRekey" }, "task": true }, { "name": "restNiegrEgressMatchRenum", "summary": "rest_niegr_EgressMatch_renum", "description": "rest_niegr_EgressMatch_renum", "input": [ { "name": "body", "type": "object", "info": ": {\"aInNewEntryFullName\": \"string\", \"aInOldEntryFullName\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInNewEntryFullName": { "type": "string" }, "aInOldEntryFullName": { "type": "string" } }, "description": "Model containing the method level model for SecurityPolicyEntryDefinition.renum to decode json data to internal NFM-P object model" } } ], "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": "/restNiegrEgressMatchRenum" }, "task": true }, { "name": "restNiegrMatchRenum", "summary": "rest_niegr_Match_renum", "description": "rest_niegr_Match_renum", "input": [ { "name": "body", "type": "object", "info": ": {\"aInNewEntryFullName\": \"string\", \"aInOldEntryFullName\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInNewEntryFullName": { "type": "string" }, "aInOldEntryFullName": { "type": "string" } }, "description": "Model containing the method level model for SecurityPolicyEntryDefinition.renum to decode json data to internal NFM-P object model" } } ], "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": "/restNiegrMatchRenum" }, "task": true }, { "name": "restNiegrPolicyFindNetworkIpInterfaces", "summary": "findNetworkIpInterfaces", "description": "Intention : RETRIEVER findNetworkIpInterfaces: instance-level [object finder] (retriever) API findNetworkIpInterfaces of class niegr.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restNiegrPolicyFindNetworkIpInterfaces" }, "task": true }, { "name": "restNqueuePolicyFindMDAs", "summary": "findMDAs", "description": "Intention : RETRIEVER findMDAs: instance-level [object finder] (retriever) API findMDAs of class nqueue.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNqueuePolicyFindMDAs" }, "task": true }, { "name": "restNqueuePolicyFindPorts", "summary": "findPorts", "description": "Intention : RETRIEVER findPorts: instance-level [object finder] (retriever) API findPorts of class nqueue.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNqueuePolicyFindPorts" }, "task": true }, { "name": "restNtpNTPLoadAuthKey", "summary": "rest_ntp_NTP_loadAuthKey", "description": "rest_ntp_NTP_loadAuthKey", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restNtpNTPLoadAuthKey" }, "task": true }, { "name": "restOpenflowOFFlowTableCountsRetrieveOFFlowTableCounts", "summary": "retrieveOFFlowTableCounts", "description": "Method used to query the OF Switch for flow table counts. Intention : RETRIEVER retrieveOFFlowTableCounts: class-level retriever API retrieveOFFlowTableCounts of class openflow.OFFlowTableCounts", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"dataPathId\": \"string\", \"flowTableId\": 123}", "required": false, "schema": { "type": "object", "required": [ "dataPathId", "flowTableId", "siteId" ], "properties": { "siteId": { "type": "string", "description": " " }, "dataPathId": { "type": "string", "description": " " }, "flowTableId": { "type": "integer", "description": " " } }, "description": "Model containing the method level model for OFFlowTableCounts.retrieveOFFlowTableCounts to decode json data to internal NFM-P object model" } } ], "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": "/restOpenflowOFFlowTableCountsRetrieveOFFlowTableCounts" }, "task": true }, { "name": "restOpticalAbstractPathFindOchCrossConnects", "summary": "findOchCrossConnects", "description": "This method finds all the OCh XCs along this path. Intention : RETRIEVER findOchCrossConnects: instance-level [object finder] (retriever) API findOchCrossConnects of class optical.AbstractPath DescendantInfo: optical.PreviewPath DescendantInfo: optical.TrailPath DescendantInfo: optical.ServicePath instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalAbstractPathFindOchCrossConnects" }, "task": true }, { "name": "restOpticalAbstractPathFindOdukCrossConnects", "summary": "findOdukCrossConnects", "description": "This method finds all OdukCrossConnect objects along this path. Intention : RETRIEVER findOdukCrossConnects: instance-level [object finder] (retriever) API findOdukCrossConnects of class optical.AbstractPath DescendantInfo: optical.PreviewPath DescendantInfo: optical.TrailPath DescendantInfo: optical.ServicePath instanceFullName : distinguished/instance name of called object List of ODUk Cross Connects", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalAbstractPathFindOdukCrossConnects" }, "task": true }, { "name": "restOpticalAbstractPathFindTrails", "summary": "findTrails", "description": "This method finds all the underlying trails associated with this path. Intention : RETRIEVER findTrails: instance-level [object finder] (retriever) API findTrails of class optical.AbstractPath DescendantInfo: optical.PreviewPath DescendantInfo: optical.TrailPath DescendantInfo: optical.ServicePath instanceFullName : distinguished/instance name of called object List of trails", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalAbstractPathFindTrails" }, "task": true }, { "name": "restOpticalAbstractPathFindVtsConnections", "summary": "findVtsConnections", "description": "This method finds all VtsConnection objects along this path. Intention : RETRIEVER findVtsConnections: instance-level [object finder] (retriever) API findVtsConnections of class optical.AbstractPath DescendantInfo: optical.PreviewPath DescendantInfo: optical.TrailPath DescendantInfo: optical.ServicePath instanceFullName : distinguished/instance name of called object List of Vts Cross Connects", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalAbstractPathFindVtsConnections" }, "task": true }, { "name": "restOpticalAbstractPowerAdjustmentRuleAbort", "summary": "rest_optical_AbstractPowerAdjustmentRule_abort", "description": "rest_optical_AbstractPowerAdjustmentRule_abort", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalAbstractPowerAdjustmentRuleAbort" }, "task": true }, { "name": "restOpticalAbstractPowerAdjustmentRuleExecute", "summary": "rest_optical_AbstractPowerAdjustmentRule_execute", "description": "rest_optical_AbstractPowerAdjustmentRule_execute", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalAbstractPowerAdjustmentRuleExecute" }, "task": true }, { "name": "restOpticalApsGroupFindApplicableOdukFacilityObjects", "summary": "findApplicableOdukFacilityObjects", "description": "This method finds all applicable client working protection ODUk facility objects required for APS Group creation Intention : RETRIEVER findApplicableOdukFacilityObjects: class-level [object finder] (retriever) API findApplicableOdukFacilityObjects of class optical.ApsGroup", "input": [ { "name": "body", "type": "object", "info": ": {\"aInApsGroupConfigInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}, \"aInOdukFacilityType\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInApsGroupConfigInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" }, "aInOdukFacilityType": { "type": "integer" } }, "description": "Model containing the method level model for ApsGroup.findApplicableOdukFacilityObjects to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalApsGroupFindApplicableOdukFacilityObjects" }, "task": true }, { "name": "restOpticalApsGroupFindApplicablePorts", "summary": "findApplicablePorts", "description": "This method finds all applicable client working protection ports required for APS Group creation Intention : RETRIEVER findApplicablePorts: class-level [object finder] (retriever) API findApplicablePorts of class optical.ApsGroup", "input": [ { "name": "body", "type": "object", "info": ": {\"aInApsGroupConfigInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}, \"aInPortType\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInApsGroupConfigInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" }, "aInPortType": { "type": "integer" } }, "description": "Model containing the method level model for ApsGroup.findApplicablePorts to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalApsGroupFindApplicablePorts" }, "task": true }, { "name": "restOpticalDiverseServiceFindSelectableServicesForDiverse", "summary": "findSelectableServicesForDiverse", "description": "This method finds all unprotected services that can be selected for creating a diverse route service Intention : RETRIEVER findSelectableServicesForDiverse: class-level [object finder] (retriever) API findSelectableServicesForDiverse of class optical.DiverseService", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalDiverseServiceFindSelectableServicesForDiverse" }, "task": true }, { "name": "restOpticalEquipAlarmCategoryResyncPerObjectAsap", "summary": "rest_optical_EquipAlarmCategory_resyncPerObjectAsap", "description": "rest_optical_EquipAlarmCategory_resyncPerObjectAsap", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restOpticalEquipAlarmCategoryResyncPerObjectAsap" }, "task": true }, { "name": "restOpticalGmreSpecificsResyncGmre", "summary": "rest_optical_GmreSpecifics_resyncGmre", "description": "rest_optical_GmreSpecifics_resyncGmre", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restOpticalGmreSpecificsResyncGmre" }, "task": true }, { "name": "restOpticalLoOdukChannelCreateCrossConnect", "summary": "rest_optical_LoOdukChannel_createCrossConnect", "description": "rest_optical_LoOdukChannel_createCrossConnect", "input": [ { "name": "body", "type": "object", "info": ": {\"aInDirection\": \"string\", \"aInLineSideLoOdukChannel\": \"string\", \"aInOdu1PtfChnanel\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInDirection": { "type": "string" }, "aInLineSideLoOdukChannel": { "type": "string" }, "aInOdu1PtfChnanel": { "type": "string" } }, "description": "Model containing the method level model for Odu1PtfChannel.createCrossConnect to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalLoOdukChannelCreateCrossConnect" }, "task": true }, { "name": "restOpticalOCHTrailFindOchCrossConnects", "summary": "findOchCrossConnects", "description": "This method finds all the OCh XCs associated with this trail. Intention : RETRIEVER findOchCrossConnects: instance-level [object finder] (retriever) API findOchCrossConnects of class optical.OCHTrail instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalOCHTrailFindOchCrossConnects" }, "task": true }, { "name": "restOpticalOCStmSpecificsBindAu", "summary": "rest_optical_OCStmSpecifics_bindAu", "description": "rest_optical_OCStmSpecifics_bindAu", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInBindRate\": 123, \"aInVcId\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInBindRate": { "type": "integer" }, "aInVcId": { "type": "integer" } }, "description": "Model containing the method level model for OCStmSpecifics.bindAu to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalOCStmSpecificsBindAu" }, "task": true }, { "name": "restOpticalOCStmSpecificsCollapseAu", "summary": "rest_optical_OCStmSpecifics_collapseAu", "description": "rest_optical_OCStmSpecifics_collapseAu", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restOpticalOCStmSpecificsCollapseAu" }, "task": true }, { "name": "restOpticalODUTrailResyncOchCrossConnects", "summary": "rest_optical_ODUTrail_resyncOchCrossConnects", "description": "rest_optical_ODUTrail_resyncOchCrossConnects", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalODUTrailResyncOchCrossConnects" }, "task": true }, { "name": "restOpticalODUTrailStartDelayMeasurement", "summary": "rest_optical_ODUTrail_startDelayMeasurement", "description": "rest_optical_ODUTrail_startDelayMeasurement", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restOpticalODUTrailStartDelayMeasurement" }, "task": true }, { "name": "restOpticalODUTrailStopDelayMeasurement", "summary": "rest_optical_ODUTrail_stopDelayMeasurement", "description": "rest_optical_ODUTrail_stopDelayMeasurement", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restOpticalODUTrailStopDelayMeasurement" }, "task": true }, { "name": "restOpticalOTPortSpecificsFindCardSlot", "summary": "findCardSlot", "description": "This method finds all the client ports which could be multicast to a Line Port. Intention : RETRIEVER findCardSlot: class-level [object finder] (retriever) API findCardSlot of class optical.OTPortSpecifics", "input": [ { "name": "portPointer", "type": "string", "info": ": string", "required": false, "schema": { "title": "portPointer", "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": "/restOpticalOTPortSpecificsFindCardSlot" }, "task": true }, { "name": "restOpticalOTPortSpecificsFindMulticastClientPorts", "summary": "findMulticastClientPorts", "description": "This method finds all the client ports which could be multicast to a Line Port. Intention : RETRIEVER findMulticastClientPorts: instance-level [object finder] (retriever) API findMulticastClientPorts of class optical.OTPortSpecifics instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "aInAttributeName", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInAttributeName", "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": "/restOpticalOTPortSpecificsFindMulticastClientPorts" }, "task": true }, { "name": "restOpticalOTUTrailFindDataBearerLinks", "summary": "findDataBearerLinks", "description": "This method finds all the DataBearer links associated with this trail. Intention : RETRIEVER findDataBearerLinks: instance-level [object finder] (retriever) API findDataBearerLinks of class optical.OTUTrail instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalOTUTrailFindDataBearerLinks" }, "task": true }, { "name": "restOpticalOTUTrailFindOchCrossConnects", "summary": "findOchCrossConnects", "description": "This method finds all the OCh XCs associated with this trail. Intention : RETRIEVER findOchCrossConnects: instance-level [object finder] (retriever) API findOchCrossConnects of class optical.OTUTrail instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalOTUTrailFindOchCrossConnects" }, "task": true }, { "name": "restOpticalOchCrossConnectFindOchCrossConnects", "summary": "findOchCrossConnects", "description": "This method finds all Och Cross Connects starting ending passing-through given port. Intention : RETRIEVER findOchCrossConnects: class-level [object finder] (retriever) API findOchCrossConnects of class optical.OchCrossConnect List of OchCrossConnects under given physical port.", "input": [ { "name": "aInPortFdn", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInPortFdn", "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": "/restOpticalOchCrossConnectFindOchCrossConnects" }, "task": true }, { "name": "restOpticalOchCrossConnectRekeyWithDuplicate", "summary": "rest_optical_OchCrossConnect_rekeyWithDuplicate", "description": "rest_optical_OchCrossConnect_rekeyWithDuplicate", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restOpticalOchCrossConnectRekeyWithDuplicate" }, "task": true }, { "name": "restOpticalOcsAlarmProfileFindEntitiesForOcsAlarmProfile", "summary": "findEntitiesForOcsAlarmProfile", "description": "Intention : RETRIEVER findEntitiesForOcsAlarmProfile: instance-level [object finder] (retriever) API findEntitiesForOcsAlarmProfile of class optical.OcsAlarmProfile instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "aInEntityType", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInEntityType", "type": "string" } }, { "name": "aInEqptCategory", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInEqptCategory", "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": "/restOpticalOcsAlarmProfileFindEntitiesForOcsAlarmProfile" }, "task": true }, { "name": "restOpticalOdu1PtfChannelCreateCrossConnect", "summary": "rest_optical_Odu1PtfChannel_createCrossConnect", "description": "rest_optical_Odu1PtfChannel_createCrossConnect", "input": [ { "name": "body", "type": "object", "info": ": {\"aInDirection\": \"string\", \"aInLineSideLoOdukChannel\": \"string\", \"aInOdu1PtfChnanel\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInDirection": { "type": "string" }, "aInLineSideLoOdukChannel": { "type": "string" }, "aInOdu1PtfChnanel": { "type": "string" } }, "description": "Model containing the method level model for Odu1PtfChannel.createCrossConnect to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalOdu1PtfChannelCreateCrossConnect" }, "task": true }, { "name": "restOpticalOdu1PtfChannelUpdateTxTimeslot", "summary": "rest_optical_Odu1PtfChannel_updateTxTimeslot", "description": "rest_optical_Odu1PtfChannel_updateTxTimeslot", "input": [ { "name": "body", "type": "object", "info": ": {\"aInOdu1PtfChnanelDn\": \"string\", \"aInTimeslotStr\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInOdu1PtfChnanelDn": { "type": "string" }, "aInTimeslotStr": { "type": "string" } }, "description": "Model containing the method level model for Odu1PtfChannel.updateTxTimeslot to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalOdu1PtfChannelUpdateTxTimeslot" }, "task": true }, { "name": "restOpticalOpticalLinkFindClientTrails", "summary": "findClientTrails", "description": "This method finds all immediate client trails (OTS OCH OCH) riding on this optical link. Intention : RETRIEVER findClientTrails: instance-level [object finder] (retriever) API findClientTrails of class optical.OpticalLink instanceFullName : distinguished/instance name of called object List of client trails riding on this optical link.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalOpticalLinkFindClientTrails" }, "task": true }, { "name": "restOpticalOpticalLinkGetChannelUsageList", "summary": "getChannelUsageList", "description": "This method returns list of optical channels riding on external optical links. Channel usage record contains CWDM DWDM Channel Number, Link Id, Link Name, Link EndpointA, Link endpointB, Site A End, Site B End, OTU OCH Trail Name, OTU OCH Trail rate, OTU OCH Trail Direction. Intention : RETRIEVER getChannelUsageList: class-level retriever API getChannelUsageList of class optical.OpticalLink Optical Channel Usage List.", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restOpticalOpticalLinkGetChannelUsageList" }, "task": true }, { "name": "restOpticalOpticalLinkGetChannelUsageListForNEGroups", "summary": "getChannelUsageListForNEGroups", "description": "This method returns list of optical channels riding on external optical links. Channel usage record contains CWDM DWDM Channel Number, Link Id, Link Name, Link EndpointA, Link endpointB, Site A End, Site B End, OTU OCH Trail Name, OTU OCH Trail rate, OTU OCH Trail Direction. Intention : RETRIEVER getChannelUsageListForNEGroups: class-level retriever API getChannelUsageListForNEGroups of class optical.OpticalLink Optical Channel Usage List.", "input": [ { "name": "body", "type": "object", "info": ": {\"aInNeGroupsList\": \"array\", \"aInFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "aInNeGroupsList": { "type": "array", "items": { "type": "string" } }, "aInFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for OpticalLink.getChannelUsageListForNEGroups to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalOpticalLinkGetChannelUsageListForNEGroups" }, "task": true }, { "name": "restOpticalOpticalNePropertiesPerformCardImageDownload", "summary": "rest_optical_OpticalNeProperties_performCardImageDownload", "description": "rest_optical_OpticalNeProperties_performCardImageDownload", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalOpticalNePropertiesPerformCardImageDownload" }, "task": true }, { "name": "restOpticalOpticalNePropertiesResyncCardImage", "summary": "rest_optical_OpticalNeProperties_resyncCardImage", "description": "rest_optical_OpticalNeProperties_resyncCardImage", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalOpticalNePropertiesResyncCardImage" }, "task": true }, { "name": "restOpticalOpticalNePropertiesUpdateReadyForDownload", "summary": "rest_optical_OpticalNeProperties_updateReadyForDownload", "description": "rest_optical_OpticalNeProperties_updateReadyForDownload", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInReadyToDownloadImages\": \"string\", \"aInSet\": \"boolean\"}", "required": false, "schema": { "type": "object", "properties": { "aInReadyToDownloadImages": { "type": "string" }, "aInSet": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for OpticalNeProperties.updateReadyForDownload to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalOpticalNePropertiesUpdateReadyForDownload" }, "task": true }, { "name": "restOpticalOpticalPortGetOpticalPortList", "summary": "getOpticalPortList", "description": "This method returns list of optical ports. Intention : RETRIEVER getOpticalPortList: class-level retriever API getOpticalPortList of class optical.OpticalPort Optical Channel Usage List containing channel number, link name, ODU Trail name, ODU Trail rate etc.", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restOpticalOpticalPortGetOpticalPortList" }, "task": true }, { "name": "restOpticalOpticalPortSpecificsFindCustomPorts", "summary": "findCustomPorts", "description": "This method finds all ports applicable for the passed attribute name as input parameter. Intention : RETRIEVER findCustomPorts: instance-level [object finder] (retriever) API findCustomPorts of class optical.OpticalPortSpecifics instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "aInAttributeName", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInAttributeName", "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": "/restOpticalOpticalPortSpecificsFindCustomPorts" }, "task": true }, { "name": "restOpticalOpticalPortSpecificsResyncAllWavekeys", "summary": "rest_optical_OpticalPortSpecifics_resyncAllWavekeys", "description": "rest_optical_OpticalPortSpecifics_resyncAllWavekeys", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteIdList\": \"array\", \"aInIfIndexList\": \"array\"}", "required": false, "schema": { "type": "object", "properties": { "aInSiteIdList": { "type": "array", "items": { "type": "string" } }, "aInIfIndexList": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for OpticalPortSpecifics.resyncAllWavekeys to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalOpticalPortSpecificsResyncAllWavekeys" }, "task": true }, { "name": "restOpticalOtdrScanSpecificsExecuteScanCommand", "summary": "rest_optical_OtdrScanSpecifics_executeScanCommand", "description": "rest_optical_OtdrScanSpecifics_executeScanCommand", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restOpticalOtdrScanSpecificsExecuteScanCommand" }, "task": true }, { "name": "restOpticalOtdrScanTransferRetrieveFile", "summary": "rest_optical_OtdrScanTransfer_retrieveFile", "description": "rest_optical_OtdrScanTransfer_retrieveFile", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restOpticalOtdrScanTransferRetrieveFile" }, "task": true }, { "name": "restOpticalOtuOduSpecificsUpdateTimeSlots", "summary": "rest_optical_OtuOduSpecifics_updateTimeSlots", "description": "rest_optical_OtuOduSpecifics_updateTimeSlots", "input": [ { "name": "body", "type": "object", "info": ": {\"otuOduFullName\": \"string\", \"oduStructStr\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "oduStructStr", "otuOduFullName" ], "properties": { "otuOduFullName": { "type": "string", "description": " Pointer to a physical port" }, "oduStructStr": { "type": "string", "description": " Pointer to a physical port" } }, "description": "Model containing the method level model for OtuOduSpecifics.updateTimeSlots to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalOtuOduSpecificsUpdateTimeSlots" }, "task": true }, { "name": "restOpticalPointToPointConnectionFindAssociatedServices", "summary": "findAssociatedServices", "description": "This method finds all the transport services riding on this connection. Intention : RETRIEVER findAssociatedServices: instance-level [object finder] (retriever) API findAssociatedServices of class optical.PointToPointConnection DescendantInfo: optical.CrossConnect DescendantInfo: gmpls.DbLink DescendantInfo: optical.LoOdukCrossConnect DescendantInfo: optical.OTCrossConnect DescendantInfo: optical.OTUTrail DescendantInfo: opticalrouting.LightPathSegment DescendantInfo: optical....(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalPointToPointConnectionFindAssociatedServices" }, "task": true }, { "name": "restOpticalPointToPointConnectionFindHops", "summary": "findHops", "description": "This method finds all hops belonging to this connection in direction A->Z or Z->A. Intention : RETRIEVER findHops: instance-level [object finder] (retriever) API findHops of class optical.PointToPointConnection DescendantInfo: optical.CrossConnect DescendantInfo: gmpls.DbLink DescendantInfo: optical.LoOdukCrossConnect DescendantInfo: optical.OTCrossConnect DescendantInfo: optical.OTUTrail DescendantInfo: opticalrouting.LightPathSegment DescendantInfo: optical.VirtualOdukCrossC...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "reverseDirection", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "reverseDirection", "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": "/restOpticalPointToPointConnectionFindHops" }, "task": true }, { "name": "restOpticalPointToPointConnectionFindOpticalLinks", "summary": "findOpticalLinks", "description": "This method finds all optical links that are part of this connection. Intention : RETRIEVER findOpticalLinks: instance-level [object finder] (retriever) API findOpticalLinks of class optical.PointToPointConnection DescendantInfo: optical.CrossConnect DescendantInfo: gmpls.DbLink DescendantInfo: optical.LoOdukCrossConnect DescendantInfo: optical.OTCrossConnect DescendantInfo: optical.OTUTrail DescendantInfo: opticalrouting.LightPathSegment DescendantInfo: optical.VirtualOdukCro...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalPointToPointConnectionFindOpticalLinks" }, "task": true }, { "name": "restOpticalPointToPointConnectionGetHopsCount", "summary": "getHopsCount", "description": "This method finds hops count belonging to this connection in direction A->Z or Z->A. Intention : RETRIEVER getHopsCount: instance-level retriever API getHopsCount of class optical.PointToPointConnection DescendantInfo: optical.CrossConnect DescendantInfo: gmpls.DbLink DescendantInfo: optical.LoOdukCrossConnect DescendantInfo: optical.OTCrossConnect DescendantInfo: optical.OTUTrail DescendantInfo: opticalrouting.LightPathSegment DescendantInfo: optical.VirtualOdukCrossConnect ...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "reverseDirection", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "reverseDirection", "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": "/restOpticalPointToPointConnectionGetHopsCount" }, "task": true }, { "name": "restOpticalPointToPointConnectionIsConnectionReversed", "summary": "isConnectionReversed", "description": "This method checks whether connection endpoints reversed or not. Intention : RETRIEVER isConnectionReversed: instance-level retriever API isConnectionReversed of class optical.PointToPointConnection DescendantInfo: optical.CrossConnect DescendantInfo: gmpls.DbLink DescendantInfo: optical.LoOdukCrossConnect DescendantInfo: optical.OTCrossConnect DescendantInfo: optical.OTUTrail DescendantInfo: opticalrouting.LightPathSegment DescendantInfo: optical.VirtualOdukCrossConnect Desc...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restOpticalPointToPointConnectionIsConnectionReversed" }, "task": true }, { "name": "restOpticalPortTCAProfileAssignerClearCounters", "summary": "rest_optical_PortTCAProfileAssigner_clearCounters", "description": "rest_optical_PortTCAProfileAssigner_clearCounters", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restOpticalPortTCAProfileAssignerClearCounters" }, "task": true }, { "name": "restOpticalPreviewPathFindHops", "summary": "findHops", "description": "This method finds all preview hops belonging to this connection in direction A->Z or Z->A. Intention : RETRIEVER findHops: instance-level [object finder] (retriever) API findHops of class optical.PreviewPath instanceFullName : distinguished/instance name of called object List of hops in A->Z or Z->A direction.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "traversalType", "type": "number", "info": ": 123", "required": false, "schema": { "title": "traversalType", "type": "number" } } ], "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": "/restOpticalPreviewPathFindHops" }, "task": true }, { "name": "restOpticalServicePathFindVcnCrossConnects", "summary": "findVcnCrossConnects", "description": "This method finds all the underlying vcn cross connects associated with this path. Intention : RETRIEVER findVcnCrossConnects: instance-level [object finder] (retriever) API findVcnCrossConnects of class optical.ServicePath instanceFullName : distinguished/instance name of called object List of VCN XCs", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalServicePathFindVcnCrossConnects" }, "task": true }, { "name": "restOpticalServiceSiteFindValidTerminatingPortsForService", "summary": "findValidTerminatingPortsForService", "description": "Intention : RETRIEVER findValidTerminatingPortsForService: class-level [object finder] (retriever) API findValidTerminatingPortsForService of class optical.ServiceSite", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteIdList\": \"array\", \"aInRate\": 123, \"aInProtectionType\": 123, \"aInDirection\": 123, \"aInIsQinQService\": \"boolean\", \"aInIsQinQFullRateService\": \"boolean\", \"aInSvcType\": 123, \"aInSitePosition\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInSiteIdList": { "type": "array", "items": { "type": "string" } }, "aInRate": { "type": "integer" }, "aInProtectionType": { "type": "integer" }, "aInDirection": { "type": "integer" }, "aInIsQinQService": { "type": "boolean", "default": false }, "aInIsQinQFullRateService": { "type": "boolean", "default": false }, "aInSvcType": { "type": "integer" }, "aInSitePosition": { "type": "integer" } }, "description": "Model containing the method level model for ServiceSite.findValidTerminatingPortsForService to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalServiceSiteFindValidTerminatingPortsForService" }, "task": true }, { "name": "restOpticalServiceSiteFindValidTerminatingPortsForServiceControlPlane", "summary": "findValidTerminatingPortsForServiceControlPlane", "description": "Intention : RETRIEVER findValidTerminatingPortsForServiceControlPlane: class-level [object finder] (retriever) API findValidTerminatingPortsForServiceControlPlane of class optical.ServiceSite", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteIdList\": \"array\", \"aInRate\": 123, \"aInProtectionType\": 123, \"aInDirection\": 123, \"aInIsQinQService\": \"boolean\", \"aInIsQinQFullRateService\": \"boolean\", \"aInSvcType\": 123, \"aInMgtDomain\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInSiteIdList": { "type": "array", "items": { "type": "string" } }, "aInRate": { "type": "integer" }, "aInProtectionType": { "type": "integer" }, "aInDirection": { "type": "integer" }, "aInIsQinQService": { "type": "boolean", "default": false }, "aInIsQinQFullRateService": { "type": "boolean", "default": false }, "aInSvcType": { "type": "integer" }, "aInMgtDomain": { "type": "integer" } }, "description": "Model containing the method level model for ServiceSite.findValidTerminatingPortsForServiceControlPlane to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalServiceSiteFindValidTerminatingPortsForServiceControlPlane" }, "task": true }, { "name": "restOpticalTrailCompleteTrails", "summary": "rest_optical_Trail_completeTrails", "description": "rest_optical_Trail_completeTrails", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restOpticalTrailCompleteTrails" }, "task": true }, { "name": "restOpticalTrailConfigureAinsMode", "summary": "configureAinsMode", "description": "This method transitions the trail to Automatic In-Service mode. Intention : MODIFIER configureAinsMode: instance-level [hierarchical administrative configuration/modification] (modifier) API configureAinsMode of class optical.Trail This API follows hierarchical config model rules. DescendantInfo: optical.OTSTrail DescendantInfo: optical.STMTrail DescendantInfo: optical.OCHTrail DescendantInfo: optical.OMSTrail DescendantInfo: optical.PortTrail DescendantInfo: optical.OTUTrail D...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalTrailConfigureAinsMode" }, "task": true }, { "name": "restOpticalTrailConfigureMaintenanceMode", "summary": "configureMaintenanceMode", "description": "This method transitions the trail to maintenance mode. Intention : MODIFIER configureMaintenanceMode: instance-level [hierarchical administrative configuration/modification] (modifier) API configureMaintenanceMode of class optical.Trail This API follows hierarchical config model rules. DescendantInfo: optical.OTSTrail DescendantInfo: optical.STMTrail DescendantInfo: optical.OCHTrail DescendantInfo: optical.OMSTrail DescendantInfo: optical.PortTrail DescendantInfo: optical.OTUTra...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalTrailConfigureMaintenanceMode" }, "task": true }, { "name": "restOpticalTrailDeleteTrails", "summary": "rest_optical_Trail_deleteTrails", "description": "rest_optical_Trail_deleteTrails", "input": [ { "name": "body", "type": "object", "info": ": {\"aInTrailFdnList\": \"array\", \"aInMultiDelete\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInTrailFdnList": { "type": "array", "items": { "type": "string" } }, "aInMultiDelete": { "type": "string" } }, "description": "Model containing the method level model for Trail.deleteTrails to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalTrailDeleteTrails" }, "task": true }, { "name": "restOpticalTrailDiscoverClientTrails", "summary": "rest_optical_Trail_discoverClientTrails", "description": "rest_optical_Trail_discoverClientTrails", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restOpticalTrailDiscoverClientTrails" }, "task": true }, { "name": "restOpticalTrailDiscoverTrail", "summary": "rest_optical_Trail_discoverTrail", "description": "rest_optical_Trail_discoverTrail", "input": [ { "name": "body", "type": "object", "info": ": {\"aInConnType\": 123, \"aInFdnList\": \"array\"}", "required": false, "schema": { "type": "object", "properties": { "aInConnType": { "type": "integer" }, "aInFdnList": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for Trail.discoverTrail to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalTrailDiscoverTrail" }, "task": true }, { "name": "restOpticalTrailDiscoverTrails", "summary": "rest_optical_Trail_discoverTrails", "description": "rest_optical_Trail_discoverTrails", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restOpticalTrailDiscoverTrails" }, "task": true }, { "name": "restOpticalTrailFindAllServerTrails", "summary": "findAllServerTrails", "description": "This method finds all server trails for this trail. Intention : RETRIEVER findAllServerTrails: instance-level [object finder] (retriever) API findAllServerTrails of class optical.Trail DescendantInfo: optical.OTSTrail DescendantInfo: optical.STMTrail DescendantInfo: optical.OCHTrail DescendantInfo: optical.OMSTrail DescendantInfo: optical.PortTrail DescendantInfo: optical.OTUTrail DescendantInfo: optical.ODUTrail instanceFullName : distinguished/instance name of called object...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalTrailFindAllServerTrails" }, "task": true }, { "name": "restOpticalTrailFindAndCompleteTrail", "summary": "rest_optical_Trail_findAndCompleteTrail", "description": "rest_optical_Trail_findAndCompleteTrail", "input": [ { "name": "endpointAPointer", "type": "string", "info": ": string", "required": false, "schema": { "title": "endpointAPointer", "type": "string" } }, { "name": "endpointZPointer", "type": "string", "info": ": string", "required": false, "schema": { "title": "endpointZPointer", "type": "string" } }, { "name": "ignoreDirection", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "ignoreDirection", "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": "/restOpticalTrailFindAndCompleteTrail" }, "task": true }, { "name": "restOpticalTrailFindApsGroups", "summary": "findApsGroups", "description": "This method finds all APS groups used for this trail. Intention : RETRIEVER findApsGroups: instance-level [object finder] (retriever) API findApsGroups of class optical.Trail DescendantInfo: optical.OTSTrail DescendantInfo: optical.STMTrail DescendantInfo: optical.OCHTrail DescendantInfo: optical.OMSTrail DescendantInfo: optical.PortTrail DescendantInfo: optical.OTUTrail DescendantInfo: optical.ODUTrail instanceFullName : distinguished/instance name of called object List of A...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalTrailFindApsGroups" }, "task": true }, { "name": "restOpticalTrailFindClientTrails", "summary": "findClientTrails", "description": "This method finds all client trails riding on this trail. Intention : RETRIEVER findClientTrails: instance-level [object finder] (retriever) API findClientTrails of class optical.Trail DescendantInfo: optical.OTSTrail DescendantInfo: optical.STMTrail DescendantInfo: optical.OCHTrail DescendantInfo: optical.OMSTrail DescendantInfo: optical.PortTrail DescendantInfo: optical.OTUTrail DescendantInfo: optical.ODUTrail instanceFullName : distinguished/instance name of called object...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalTrailFindClientTrails" }, "task": true }, { "name": "restOpticalTrailFindServerTrails", "summary": "findServerTrails", "description": "Given the protection state (unprotected working protection), this method finds the matching server trails that this trail is riding on. Intention : RETRIEVER findServerTrails: instance-level [object finder] (retriever) API findServerTrails of class optical.Trail DescendantInfo: optical.OTSTrail DescendantInfo: optical.STMTrail DescendantInfo: optical.OCHTrail DescendantInfo: optical.OMSTrail DescendantInfo: optical.PortTrail DescendantInfo: optical.OTUTrail DescendantInfo: opt...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "aInProtectionState", "type": "number", "info": ": 123", "required": false, "schema": { "title": "aInProtectionState", "type": "number" } } ], "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": "/restOpticalTrailFindServerTrails" }, "task": true }, { "name": "restOpticalTrailRekeyConnection", "summary": "rest_optical_Trail_rekeyConnection", "description": "rest_optical_Trail_rekeyConnection", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restOpticalTrailRekeyConnection" }, "task": true }, { "name": "restOpticalTrailShutDown", "summary": "rest_optical_Trail_shutDown", "description": "rest_optical_Trail_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restOpticalTrailShutDown" }, "task": true }, { "name": "restOpticalTrailTurnUp", "summary": "rest_optical_Trail_turnUp", "description": "rest_optical_Trail_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restOpticalTrailTurnUp" }, "task": true }, { "name": "restOpticalTrailUnmanageTrails", "summary": "rest_optical_Trail_unmanageTrails", "description": "rest_optical_Trail_unmanageTrails", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restOpticalTrailUnmanageTrails" }, "task": true }, { "name": "restOpticalTrailSiteFindValidTerminationPointsForTrail", "summary": "findValidTerminationPointsForTrail", "description": "Intention : RETRIEVER findValidTerminationPointsForTrail: class-level [object finder] (retriever) API findValidTerminationPointsForTrail of class optical.TrailSite", "input": [ { "name": "body", "type": "object", "info": ": {\"aInTrailInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\"}, \"aInTrailSiteInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\"}}", "required": false, "schema": { "type": "object", "properties": { "aInTrailInfo": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" }, "aInTrailSiteInfo": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for TrailSite.findValidTerminationPointsForTrail to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalTrailSiteFindValidTerminationPointsForTrail" }, "task": true }, { "name": "restOpticalTransportServiceCompleteService", "summary": "rest_optical_TransportService_completeService", "description": "rest_optical_TransportService_completeService", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restOpticalTransportServiceCompleteService" }, "task": true }, { "name": "restOpticalTransportServiceConfigureAinsMode", "summary": "configureAinsMode", "description": "This method transitions the service to Automatic In-Service mode. Intention : MODIFIER configureAinsMode: instance-level [hierarchical administrative configuration/modification] (modifier) API configureAinsMode of class optical.TransportService This API follows hierarchical config model rules. DescendantInfo: optical.MultipointTransportService instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalTransportServiceConfigureAinsMode" }, "task": true }, { "name": "restOpticalTransportServiceConfigureMaintenanceMode", "summary": "configureMaintenanceMode", "description": "This method transitions the service to maintenance mode. Intention : MODIFIER configureMaintenanceMode: instance-level [hierarchical administrative configuration/modification] (modifier) API configureMaintenanceMode of class optical.TransportService This API follows hierarchical config model rules. DescendantInfo: optical.MultipointTransportService instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalTransportServiceConfigureMaintenanceMode" }, "task": true }, { "name": "restOpticalTransportServiceDeleteServices", "summary": "rest_optical_TransportService_deleteServices", "description": "rest_optical_TransportService_deleteServices", "input": [ { "name": "body", "type": "object", "info": ": {\"aInMultiDelete\": \"string\", \"aInServicesFdnList\": \"array\"}", "required": false, "schema": { "type": "object", "properties": { "aInMultiDelete": { "type": "string" }, "aInServicesFdnList": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for TransportService.deleteServices to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalTransportServiceDeleteServices" }, "task": true }, { "name": "restOpticalTransportServiceDeleteWithODUTrail", "summary": "rest_optical_TransportService_deleteWithODUTrail", "description": "rest_optical_TransportService_deleteWithODUTrail", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalTransportServiceDeleteWithODUTrail" }, "task": true }, { "name": "restOpticalTransportServiceDiscoverService", "summary": "rest_optical_TransportService_discoverService", "description": "rest_optical_TransportService_discoverService", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restOpticalTransportServiceDiscoverService" }, "task": true }, { "name": "restOpticalTransportServiceDiscoverServiceNEs", "summary": "rest_optical_TransportService_discoverServiceNEs", "description": "rest_optical_TransportService_discoverServiceNEs", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restOpticalTransportServiceDiscoverServiceNEs" }, "task": true }, { "name": "restOpticalTransportServiceDiscoverServiceOnTrails", "summary": "rest_optical_TransportService_discoverServiceOnTrails", "description": "rest_optical_TransportService_discoverServiceOnTrails", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restOpticalTransportServiceDiscoverServiceOnTrails" }, "task": true }, { "name": "restOpticalTransportServiceFindAllServicePaths", "summary": "findAllServicePaths", "description": "This method returns all the ServicePath objects for this transport service Intention : RETRIEVER findAllServicePaths: instance-level [object finder] (retriever) API findAllServicePaths of class optical.TransportService DescendantInfo: optical.MultipointTransportService instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOpticalTransportServiceFindAllServicePaths" }, "task": true }, { "name": "restOpticalTransportServiceFindApsGroups", "summary": "findApsGroups", "description": "This method finds all APS Groups used for this service Intention : RETRIEVER findApsGroups: instance-level [object finder] (retriever) API findApsGroups of class optical.TransportService DescendantInfo: optical.MultipointTransportService instanceFullName : distinguished/instance name of called object List of APS groups", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restOpticalTransportServiceFindApsGroups" }, "task": true }, { "name": "restOpticalTransportServiceFindServicePath", "summary": "findServicePath", "description": "This method returns the ServicePath object with serviceMode matching the in Intention : RETRIEVER findServicePath: instance-level [object finder] (retriever) API findServicePath of class optical.TransportService DescendantInfo: optical.MultipointTransportService instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "serviceMode", "type": "string", "info": ": string", "required": false, "schema": { "title": "serviceMode", "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": "/restOpticalTransportServiceFindServicePath" }, "task": true }, { "name": "restOpticalTransportServiceGetAlarms", "summary": "getAlarms", "description": "This method returns alarms on all failed objects in a service.It used by Optical Service View web app. Intention : RETRIEVER getAlarms: instance-level retriever API getAlarms of class optical.TransportService DescendantInfo: optical.MultipointTransportService instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restOpticalTransportServiceGetAlarms" }, "task": true }, { "name": "restOpticalTransportServiceGetHopsCount", "summary": "getHopsCount", "description": "This method finds hops count belonging to this connection in direction A->Z or Z->A. Intention : RETRIEVER getHopsCount: class-level retriever API getHopsCount of class optical.TransportService DescendantInfo: optical.MultipointTransportService Number of hops in A->Z Z->A direction.", "input": [ { "name": "body", "type": "object", "info": ": {\"svcMgrId\": 123, \"pathType\": 123, \"reverseDirection\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "pathType", "reverseDirection", "svcMgrId" ], "properties": { "svcMgrId": { "type": "integer", "description": " Service manager Id." }, "pathType": { "type": "integer", "description": " Path type - unprotected(1) working(2) protected(3)." }, "reverseDirection": { "type": "boolean", "description": " If 'false' the hops count done in direction from A to Z.If 'true' the hops count done in reverse direction (from Z to A).", "default": false } }, "description": "Model containing the method level model for TransportService.getHopsCount to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalTransportServiceGetHopsCount" }, "task": true }, { "name": "restOpticalTransportServiceLightPathTrace", "summary": "lightPathTrace", "description": "Given a physical port and ITUChannel, this method traces the optical channel across the shelf. Intention : RETRIEVER lightPathTrace: class-level retriever API lightPathTrace of class optical.TransportService DescendantInfo: optical.MultipointTransportService", "input": [ { "name": "body", "type": "object", "info": ": {\"portPointer\": \"string\", \"channel\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "channel", "portPointer" ], "properties": { "portPointer": { "type": "string", "description": " Pointer to a physical port" }, "channel": { "type": "string", "description": " ITU channel" } }, "description": "Model containing the method level model for TransportService.lightPathTrace to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalTransportServiceLightPathTrace" }, "task": true }, { "name": "restOpticalTransportServiceRecomputeStates", "summary": "rest_optical_TransportService_recomputeStates", "description": "rest_optical_TransportService_recomputeStates", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restOpticalTransportServiceRecomputeStates" }, "task": true }, { "name": "restOpticalTransportServiceRekeyConnection", "summary": "rest_optical_TransportService_rekeyConnection", "description": "rest_optical_TransportService_rekeyConnection", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restOpticalTransportServiceRekeyConnection" }, "task": true }, { "name": "restOpticalTransportServiceShutDown", "summary": "rest_optical_TransportService_shutDown", "description": "rest_optical_TransportService_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restOpticalTransportServiceShutDown" }, "task": true }, { "name": "restOpticalTransportServiceTurnUpService", "summary": "rest_optical_TransportService_turnUpService", "description": "rest_optical_TransportService_turnUpService", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restOpticalTransportServiceTurnUpService" }, "task": true }, { "name": "restOpticalTransportServiceUnmanageServices", "summary": "rest_optical_TransportService_unmanageServices", "description": "rest_optical_TransportService_unmanageServices", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restOpticalTransportServiceUnmanageServices" }, "task": true }, { "name": "restOpticalVtsAlarmCategoryResyncPerVtsObjectAsap", "summary": "rest_optical_VtsAlarmCategory_resyncPerVtsObjectAsap", "description": "rest_optical_VtsAlarmCategory_resyncPerVtsObjectAsap", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInVtsMapIfIndexList\": \"array\"}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInVtsMapIfIndexList": { "type": "array", "items": { "type": "integer" } } }, "description": "Model containing the method level model for VtsAlarmCategory.resyncPerVtsObjectAsap to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalVtsAlarmCategoryResyncPerVtsObjectAsap" }, "task": true }, { "name": "restOpticalVtsConnectionFindValidTerminatingPortsForVtsConnection", "summary": "findValidTerminatingPortsForVtsConnection", "description": "Intention : RETRIEVER findValidTerminatingPortsForVtsConnection: class-level [object finder] (retriever) API findValidTerminatingPortsForVtsConnection of class optical.VtsConnection", "input": [ { "name": "aInSiteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInSiteId", "type": "string" } }, { "name": "aInOtherEndpointFdn", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInOtherEndpointFdn", "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": "/restOpticalVtsConnectionFindValidTerminatingPortsForVtsConnection" }, "task": true }, { "name": "restOpticalaclIpFilterEntryRenum", "summary": "rest_opticalacl_IpFilterEntry_renum", "description": "rest_opticalacl_IpFilterEntry_renum", "input": [ { "name": "body", "type": "object", "info": ": {\"aInNewEntryFullName\": \"string\", \"aInOldEntryFullName\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInNewEntryFullName": { "type": "string" }, "aInOldEntryFullName": { "type": "string" } }, "description": "Model containing the method level model for SecurityPolicyEntryDefinition.renum to decode json data to internal NFM-P object model" } } ], "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": "/restOpticalaclIpFilterEntryRenum" }, "task": true }, { "name": "restOpticsperfOpticsPMPolicyFindPSSs", "summary": "findPSSs", "description": "Find all managed PSSs for the specified Performance Management polling policy assigned. Intention : RETRIEVER findPSSs: class-level [object finder] (retriever) API findPSSs of class opticsperf.OpticsPMPolicy DescendantInfo: opticsperf.PSSPMPolicy", "input": [ { "name": "policyId", "type": "number", "info": ": 123", "required": false, "schema": { "title": "policyId", "type": "number" } } ], "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": "/restOpticsperfOpticsPMPolicyFindPSSs" }, "task": true }, { "name": "restOpticsperfPMConfigClearPMCounters", "summary": "rest_opticsperf_PMConfig_clearPMCounters", "description": "rest_opticsperf_PMConfig_clearPMCounters", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restOpticsperfPMConfigClearPMCounters" }, "task": true }, { "name": "restOspfInterfaceRemovePassword", "summary": "rest_ospf_Interface_removePassword", "description": "rest_ospf_Interface_removePassword", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOspfInterfaceRemovePassword" }, "task": true }, { "name": "restOspfShamLinkRemovePassword", "summary": "rest_ospf_ShamLink_removePassword", "description": "rest_ospf_ShamLink_removePassword", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOspfShamLinkRemovePassword" }, "task": true }, { "name": "restOspfSiteExtensionInitiatePlannedRestart", "summary": "rest_ospf_SiteExtension_initiatePlannedRestart", "description": "rest_ospf_SiteExtension_initiatePlannedRestart", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInOspfVersion\": 123, \"aInOspfInstanceIndex\": 123, \"aInRouterId\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInOspfVersion": { "type": "integer" }, "aInOspfInstanceIndex": { "type": "integer" }, "aInRouterId": { "type": "integer" } }, "description": "Model containing the method level model for SiteExtension.initiatePlannedRestart to decode json data to internal NFM-P object model" } } ], "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": "/restOspfSiteExtensionInitiatePlannedRestart" }, "task": true }, { "name": "restOspfVirtualLinkRemovePassword", "summary": "rest_ospf_VirtualLink_removePassword", "description": "rest_ospf_VirtualLink_removePassword", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restOspfVirtualLinkRemovePassword" }, "task": true }, { "name": "restOthOdukPtfBuildHigherRateOdu", "summary": "rest_oth_OdukPtf_buildHigherRateOdu", "description": "rest_oth_OdukPtf_buildHigherRateOdu", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInLoOduId\": 123, \"aInTimeSlots\": \"string\", \"aInRate\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInLoOduId": { "type": "integer" }, "aInTimeSlots": { "type": "string" }, "aInRate": { "type": "string" } }, "description": "Model containing the method level model for OdukPtf.buildHigherRateOdu to decode json data to internal NFM-P object model" } } ], "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": "/restOthOdukPtfBuildHigherRateOdu" }, "task": true }, { "name": "restOthOdukPtfCollapseHigherRateOdu", "summary": "rest_oth_OdukPtf_collapseHigherRateOdu", "description": "rest_oth_OdukPtf_collapseHigherRateOdu", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restOthOdukPtfCollapseHigherRateOdu" }, "task": true }, { "name": "restOthOdukPtfGetOdu1PtfObject", "summary": "getOdu1PtfObject", "description": "Retrieve the Odu1PtfChannel objects. Intention : RETRIEVER getOdu1PtfObject: class-level retriever API getOdu1PtfObject of class oth.OdukPtf", "input": [ { "name": "aInOdukPtfDn", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInOdukPtfDn", "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": "/restOthOdukPtfGetOdu1PtfObject" }, "task": true }, { "name": "restOthOdukPtfGetOptsgObjects", "summary": "getOptsgObjects", "description": "Retrieve the OPTSG objects. Intention : RETRIEVER getOptsgObjects: class-level retriever API getOptsgObjects of class oth.OdukPtf", "input": [ { "name": "aInOdukPtfDn", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInOdukPtfDn", "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": "/restOthOdukPtfGetOptsgObjects" }, "task": true }, { "name": "restOthOdukPtfUpdateTimeSlots", "summary": "rest_oth_OdukPtf_updateTimeSlots", "description": "rest_oth_OdukPtf_updateTimeSlots", "input": [ { "name": "body", "type": "object", "info": ": {\"otuOduFullName\": \"string\", \"oduStructStr\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "oduStructStr", "otuOduFullName" ], "properties": { "otuOduFullName": { "type": "string", "description": " Pointer to a physical port" }, "oduStructStr": { "type": "string", "description": " Pointer to a physical port" } }, "description": "Model containing the method level model for OtuOduSpecifics.updateTimeSlots to decode json data to internal NFM-P object model" } } ], "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": "/restOthOdukPtfUpdateTimeSlots" }, "task": true }, { "name": "restPae8021xRadiusServerItemFind", "summary": "find", "description": "Intention : RETRIEVER find: class-level [object finder] (retriever) API find of class pae802_1x.RadiusServerItem", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restPae8021xRadiusServerItemFind" }, "task": true }, { "name": "restPae8021xRadiusServerPolicyFindPorts", "summary": "findPorts", "description": "Intention : RETRIEVER findPorts: instance-level [object finder] (retriever) API findPorts of class pae802_1x.RadiusServerPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restPae8021xRadiusServerPolicyFindPorts" }, "task": true }, { "name": "restPae8021xSiteShutDown", "summary": "rest_pae802_1x_Site_shutDown", "description": "rest_pae802_1x_Site_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restPae8021xSiteShutDown" }, "task": true }, { "name": "restPae8021xSiteTurnUp", "summary": "rest_pae802_1x_Site_turnUp", "description": "rest_pae802_1x_Site_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restPae8021xSiteTurnUp" }, "task": true }, { "name": "restPimSiteConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class pim.Site This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restPimSiteConfigure" }, "task": true }, { "name": "restPimVirtualAnyCastRPAddAnyCastRPMember", "summary": "rest_pim_VirtualAnyCastRP_addAnyCastRPMember", "description": "rest_pim_VirtualAnyCastRP_addAnyCastRPMember", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInLocalAddressFdn\": \"array\", \"aInRpLoopbackIfName\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInLocalAddressFdn": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "aInRpLoopbackIfName": { "type": "string" } }, "description": "Model containing the method level model for VirtualAnyCastRP.addAnyCastRPMember to decode json data to internal NFM-P object model" } } ], "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": "/restPimVirtualAnyCastRPAddAnyCastRPMember" }, "task": true }, { "name": "restPimVirtualAnyCastRPFindLocalAddress", "summary": "findLocalAddress", "description": "finds local addresses that can be added to an Virtual Anycast RP Intention : RETRIEVER findLocalAddress: class-level [object finder] (retriever) API findLocalAddress of class pim.VirtualAnyCastRP", "input": [ { "name": "body", "type": "object", "info": ": {\"virtualAnyCastRPFullName\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter", "virtualAnyCastRPFullName" ], "properties": { "virtualAnyCastRPFullName": { "type": "string", "description": " " }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for VirtualAnyCastRP.findLocalAddress to decode json data to internal NFM-P object model" } } ], "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": "/restPimVirtualAnyCastRPFindLocalAddress" }, "task": true }, { "name": "restPimVirtualAnyCastRPUpdateStatusFlags", "summary": "rest_pim_VirtualAnyCastRP_updateStatusFlags", "description": "rest_pim_VirtualAnyCastRP_updateStatusFlags", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restPimVirtualAnyCastRPUpdateStatusFlags" }, "task": true }, { "name": "restPolicyManagerAudit", "summary": "rest_policy_Manager_audit", "description": "rest_policy_Manager_audit", "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": "/restPolicyManagerAudit" }, "task": true }, { "name": "restPolicyManagerAuditLocalPolicy", "summary": "auditLocalPolicy", "description": "Compare the differences between two local policies or between the local and global policy. Intention : RETRIEVER auditLocalPolicy: class-level retriever API auditLocalPolicy of class policy.Manager The struct shows the list of properties which are different between two local policies or between the local and global policy.", "input": [ { "name": "body", "type": "object", "info": ": {\"comparingPolicyObjectFullName\": \"string\", \"comparedPolicySiteId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "comparedPolicySiteId", "comparingPolicyObjectFullName" ], "properties": { "comparingPolicyObjectFullName": { "type": "string", "description": " The object full name of one of the local policy." }, "comparedPolicySiteId": { "type": "string", "description": " The siteId of second local policy. Empty string or \"0.0.0.0\" means the global policy." } }, "description": "Model containing the method level model for Manager.auditLocalPolicy to decode json data to internal NFM-P object model" } } ], "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": "/restPolicyManagerAuditLocalPolicy" }, "task": true }, { "name": "restPolicyManagerAuditLocalPolicyWithInApplicableAttributeOption", "summary": "auditLocalPolicyWithInApplicableAttributeOption", "description": "Compare the differences between two local policies or between the local and global policy. Intention : RETRIEVER auditLocalPolicyWithInApplicableAttributeOption: class-level retriever API auditLocalPolicyWithInApplicableAttributeOption of class policy.Manager The struct shows the list of properties which are different between two local policies or between the local and global policy.", "input": [ { "name": "body", "type": "object", "info": ": {\"comparingPolicyObjectFullName\": \"string\", \"comparedPolicySiteId\": \"string\", \"includeInapplicableAttributes\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "comparedPolicySiteId", "comparingPolicyObjectFullName", "includeInapplicableAttributes" ], "properties": { "comparingPolicyObjectFullName": { "type": "string", "description": " The object full name of one of the local policy." }, "comparedPolicySiteId": { "type": "string", "description": " The siteId of second local policy. Empty string or \"0.0.0.0\" means the global policy." }, "includeInapplicableAttributes": { "type": "boolean", "description": " True if inapplicable attributes needs to be considered during audit, else false.", "default": false } }, "description": "Model containing the method level model for Manager.auditLocalPolicyWithInApplicableAttributeOption to decode json data to internal NFM-P object model" } } ], "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": "/restPolicyManagerAuditLocalPolicyWithInApplicableAttributeOption" }, "task": true }, { "name": "restPolicyManagerAuditPolicies", "summary": "rest_policy_Manager_auditPolicies", "description": "rest_policy_Manager_auditPolicies", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"selectedPolicies\": \"array\", \"alarmAllDifferences\": \"boolean\", \"selectedNEList\": \"array\", \"localEditDifferences\": \"boolean\", \"globalSyncNonDifferences\": \"boolean\", \"globalPoliciesNames\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "alarmAllDifferences", "globalPoliciesNames", "globalSyncNonDifferences", "localEditDifferences", "objectClassName", "selectedNEList", "selectedPolicies" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "selectedPolicies": { "type": "array", "items": { "type": "integer" } }, "alarmAllDifferences": { "type": "boolean", "default": false }, "selectedNEList": { "type": "array", "items": { "type": "string" } }, "localEditDifferences": { "type": "boolean", "default": false }, "globalSyncNonDifferences": { "type": "boolean", "default": false }, "globalPoliciesNames": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct AuditSelectedPoliciesInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restPolicyManagerAuditPolicies" }, "task": true }, { "name": "restPolicyManagerCheckBulkDistributeWithinCapacity", "summary": "checkBulkDistributeWithinCapacity", "description": "This method is used when multiple policies are selected for distribution. It checks if the number of tasks created for bulk policy distribution is within configured capacity. Intention : MODIFIER checkBulkDistributeWithinCapacity: instance-level modifier API checkBulkDistributeWithinCapacity of class policy.Manager instanceFullName : distinguished/instance name of called object True if the number of tasks is within configured maximum, false otherwise.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"siteIds\": \"array\", \"instanceNames\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "instanceNames", "siteIds" ], "properties": { "siteIds": { "type": "array", "description": " The siteId list for distribution. If the list is empty the behavior is driven bythe attribute allSitesIncluded.", "items": { "type": "string" } }, "instanceNames": { "type": "array", "description": " List of policy instance names to be distributed.", "items": { "type": "string" } } }, "description": "Model containing the method level model for Manager.checkBulkDistributeWithinCapacity to decode json data to internal NFM-P object model" } } ], "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": "/restPolicyManagerCheckBulkDistributeWithinCapacity" }, "task": true }, { "name": "restPolicyManagerCopyMovePolicyEntries", "summary": "rest_policy_Manager_copyMovePolicyEntries", "description": "rest_policy_Manager_copyMovePolicyEntries", "input": [ { "name": "body", "type": "object", "info": ": {\"selectedPolicyEntries\": \"array\", \"policyInfoList\": \"array\", \"entryOverride\": \"boolean\", \"globalPolicyDistribute\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "entryOverride", "globalPolicyDistribute", "policyInfoList", "selectedPolicyEntries" ], "properties": { "selectedPolicyEntries": { "type": "array", "description": " List of policy entries that need to copied or overridden for a given policy list.", "items": { "type": "string" } }, "policyInfoList": { "type": "array", "description": " List of global policies to which the selected policy Entries will be copied overridden.", "items": { "type": "string" } }, "entryOverride": { "type": "boolean", "description": " Indicates if any existing entries in a given policy can be overridden with selected entries.", "default": false }, "globalPolicyDistribute": { "type": "boolean", "description": " Indicates if the global policy needs to be distributed post copy operation.", "default": false } }, "description": "Model containing the method level model for Manager.copyMovePolicyEntries to decode json data to internal NFM-P object model" } } ], "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": "/restPolicyManagerCopyMovePolicyEntries" }, "task": true }, { "name": "restPolicyManagerDeleteExportedFile", "summary": "rest_policy_Manager_deleteExportedFile", "description": "rest_policy_Manager_deleteExportedFile", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restPolicyManagerDeleteExportedFile" }, "task": true }, { "name": "restPolicyManagerExportPolicies", "summary": "rest_policy_Manager_exportPolicies", "description": "rest_policy_Manager_exportPolicies", "input": [ { "name": "body", "type": "object", "info": ": {\"selectedGlobalPolicies\": \"array\", \"exportFileName\": \"string\", \"description\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "description", "exportFileName", "selectedGlobalPolicies" ], "properties": { "selectedGlobalPolicies": { "type": "array", "description": " List of global policies that needs to be exported to an xml file.", "items": { "type": "string" } }, "exportFileName": { "type": "string", "description": " Indicates the xml file name in which the selected global policies in NFM-P will be exported too." }, "description": { "type": "string", "description": " This can be used to denote user description before executing the export operation." } }, "description": "Model containing the method level model for Manager.exportPolicies to decode json data to internal NFM-P object model" } } ], "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": "/restPolicyManagerExportPolicies" }, "task": true }, { "name": "restPolicyManagerFindExportPolicyFileInfo", "summary": "findExportPolicyFileInfo", "description": "Finds all exported policy file names for a given policy class, along with its description and exported NFM-P version. Intention : RETRIEVER findExportPolicyFileInfo: class-level [object finder] (retriever) API findExportPolicyFileInfo of class policy.Manager", "input": [ { "name": "policyClassName", "type": "string", "info": ": string", "required": false, "schema": { "title": "policyClassName", "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": "/restPolicyManagerFindExportPolicyFileInfo" }, "task": true }, { "name": "restPolicyManagerFindPolicy", "summary": "findPolicy", "description": "Finds all policies managed by this instance of policy manager and passing the filter specified as parameter. If a policy type is not supported on a Network Element the policy manager of that type may not exist on that Network Element. In this case this method will throw an 'object not found' exception because the policy manager was not found. One can use the method 'findPolicyOfType' as an alternative in this case. Intention : RETRIEVER findPolicy: instance-level [object finder] (retriever) ...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restPolicyManagerFindPolicy" }, "task": true }, { "name": "restPolicyManagerFindPolicyOfType", "summary": "findPolicyOfType", "description": "Finds all policies of a given policy type and passing the filter specified as parameter. This is a class-level method and does not require that the given policy manager should exist. If the policy manager does not exist this method will simply return an empty list. Intention : RETRIEVER findPolicyOfType: class-level [object finder] (retriever) API findPolicyOfType of class policy.Manager", "input": [ { "name": "body", "type": "object", "info": ": {\"policyType\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter", "policyType" ], "properties": { "policyType": { "type": "string", "description": " " }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for Manager.findPolicyOfType to decode json data to internal NFM-P object model" } } ], "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": "/restPolicyManagerFindPolicyOfType" }, "task": true }, { "name": "restPolicyManagerGetAuditStatus", "summary": "getAuditStatus", "description": "Return the summary of AuditStatus object (see AuditStatus for the details). Intention : RETRIEVER getAuditStatus: class-level retriever API getAuditStatus of class policy.Manager", "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": "/restPolicyManagerGetAuditStatus" }, "task": true }, { "name": "restPolicyManagerImportPolicies", "summary": "importPolicies", "description": "Intention : MODIFIER importPolicies: class-level modifier API importPolicies of class policy.Manager", "input": [ { "name": "body", "type": "object", "info": ": {\"importFileName\": \"string\", \"overrideExistingGlobalPolicy\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "importFileName", "overrideExistingGlobalPolicy" ], "properties": { "importFileName": { "type": "string", "description": " Indicates the xml file name from which the global policies would be created in NFM-P." }, "overrideExistingGlobalPolicy": { "type": "boolean", "description": " Indicates if the global policy already exists in NFM-P, then, should it overridden with the imported global policy or not.", "default": false } }, "description": "Model containing the method level model for Manager.importPolicies to decode json data to internal NFM-P object model" } } ], "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": "/restPolicyManagerImportPolicies" }, "task": true }, { "name": "restPolicyManagerInterruptAudit", "summary": "rest_policy_Manager_interruptAudit", "description": "rest_policy_Manager_interruptAudit", "input": [ { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restPolicyManagerInterruptAudit" }, "task": true }, { "name": "restPolicyManagerPreviewPolicyList", "summary": "previewPolicyList", "description": "Intention : RETRIEVER previewPolicyList: class-level retriever API previewPolicyList of class policy.Manager", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restPolicyManagerPreviewPolicyList" }, "task": true }, { "name": "restPolicyPolicyDefinitionDistribute", "summary": "distribute", "description": "The global policy is distributed to the NEs specified in siteIds. If the distribution fails NFM-P validation for one NE, the global policy would not be distributed to any NEs. The max size of NEs which can be distributed is calculated from the policyDistributionMaxObjectLimit divided by the number of items in the global policy. The policyDistributionMaxObjectLimit is defined in nms-server.xml. Use {{policy.PolicyDefinition.distributeV2()}} for scaled distribution. Intention : MODIFIER distrib...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restPolicyPolicyDefinitionDistribute" }, "task": true }, { "name": "restPolicyPolicyDefinitionDistributeUsingGroups", "summary": "distributeUsingGroups", "description": "The global policy is distributed to the NEs present in the groups. If the distribution fails for one NE, the distribution continues for the rest of the NEs. A JMS message is sent back to indicate the list of failed sites Intention : MODIFIER distributeUsingGroups: instance-level modifier API distributeUsingGroups of class policy.PolicyDefinition DescendantInfo: rtr.SegmentRoutingMaintenancePolicy DescendantInfo: lte5g.PcfIdList DescendantInfo: mplstp.BFDTemplate DescendantInfo: ixrq...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restPolicyPolicyDefinitionDistributeUsingGroups" }, "task": true }, { "name": "restPolicyPolicyDefinitionDistributeV2", "summary": "distributeV2", "description": "The global policy is distributed to the NEs specified in siteIds. If the distribution fails for one NE, the distribution continues for the rest of NEs. The JMS message is sent back to indicate the list of failed sites. Intention : MODIFIER distributeV2: instance-level modifier API distributeV2 of class policy.PolicyDefinition DescendantInfo: rtr.SegmentRoutingMaintenancePolicy DescendantInfo: lte5g.PcfIdList DescendantInfo: mplstp.BFDTemplate DescendantInfo: ixrqos.VlanQosPolicy De...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"siteIds\": \"array\", \"allSitesIncluded\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "allSitesIncluded", "siteIds" ], "properties": { "siteIds": { "type": "array", "description": " The siteId list for distribution. If the list is empty the behavior is driven bythe attribute allSitesIncluded.", "items": { "type": "string" } }, "allSitesIncluded": { "type": "boolean", "description": " (Optional) The default is \"false\". Applicable only if siteIds is an empty list.If allSitesIncluded is true, the policy is distributed to all applicable NEs. default:false", "default": false } }, "description": "Model containing the method level model for PolicyDefinition.distributeV2 to decode json data to internal NFM-P object model" } } ], "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": "/restPolicyPolicyDefinitionDistributeV2" }, "task": true }, { "name": "restPolicyPolicyDefinitionEvaluatePolicy", "summary": "evaluatePolicy", "description": "Intention : RETRIEVER evaluatePolicy: instance-level retriever API evaluatePolicy of class policy.PolicyDefinition DescendantInfo: rtr.SegmentRoutingMaintenancePolicy DescendantInfo: lte5g.PcfIdList DescendantInfo: mplstp.BFDTemplate DescendantInfo: ixrqos.VlanQosPolicy DescendantInfo: ressubscr.ShcvPolicy DescendantInfo: ltepolicyoptions.AssumePositiveActionProfile DescendantInfo: ixrqos.FcLspExpMap DescendantInfo: aclfilterli.LiIpv6Filter DescendantInfo: subscrexpmap.Pol...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restPolicyPolicyDefinitionEvaluatePolicy" }, "task": true }, { "name": "restPolicyPolicyDefinitionFindGlobal", "summary": "findGlobal", "description": "Find the global policy for this local definition. Intention : RETRIEVER findGlobal: instance-level [object finder] (retriever) API findGlobal of class policy.PolicyDefinition DescendantInfo: rtr.SegmentRoutingMaintenancePolicy DescendantInfo: lte5g.PcfIdList DescendantInfo: mplstp.BFDTemplate DescendantInfo: ixrqos.VlanQosPolicy DescendantInfo: ressubscr.ShcvPolicy DescendantInfo: ltepolicyoptions.AssumePositiveActionProfile DescendantInfo: ixrqos.FcLspExpMap DescendantInfo: ...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restPolicyPolicyDefinitionFindGlobal" }, "task": true }, { "name": "restPolicyPolicyDefinitionFindLocal", "summary": "findLocal", "description": "Find all the local definitions under this global policy. Intention : RETRIEVER findLocal: instance-level [object finder] (retriever) API findLocal of class policy.PolicyDefinition DescendantInfo: rtr.SegmentRoutingMaintenancePolicy DescendantInfo: lte5g.PcfIdList DescendantInfo: mplstp.BFDTemplate DescendantInfo: ixrqos.VlanQosPolicy DescendantInfo: ressubscr.ShcvPolicy DescendantInfo: ltepolicyoptions.AssumePositiveActionProfile DescendantInfo: ixrqos.FcLspExpMap DescendantI...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restPolicyPolicyDefinitionFindLocal" }, "task": true }, { "name": "restPolicyPolicyDefinitionFindReleased", "summary": "findReleased", "description": "Find the most recent released policy. Intention : RETRIEVER findReleased: instance-level [object finder] (retriever) API findReleased of class policy.PolicyDefinition DescendantInfo: rtr.SegmentRoutingMaintenancePolicy DescendantInfo: lte5g.PcfIdList DescendantInfo: mplstp.BFDTemplate DescendantInfo: ixrqos.VlanQosPolicy DescendantInfo: ressubscr.ShcvPolicy DescendantInfo: ltepolicyoptions.AssumePositiveActionProfile DescendantInfo: ixrqos.FcLspExpMap DescendantInfo: aclfilt...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restPolicyPolicyDefinitionFindReleased" }, "task": true }, { "name": "restPolicyPolicyDefinitionGetSyncTaskResult", "summary": "getSyncTaskResult", "description": "Method to get sync task result Intention : ACCESSOR getSyncTaskResult: class-level accessor API getSyncTaskResult of class policy.PolicyDefinition DescendantInfo: rtr.SegmentRoutingMaintenancePolicy DescendantInfo: lte5g.PcfIdList DescendantInfo: mplstp.BFDTemplate DescendantInfo: ixrqos.VlanQosPolicy DescendantInfo: ressubscr.ShcvPolicy DescendantInfo: ltepolicyoptions.AssumePositiveActionProfile DescendantInfo: ixrqos.FcLspExpMap DescendantInfo: aclfilterli.LiIpv6Filter D...(description truncated)", "input": [ { "name": "distinguishedName", "type": "string", "info": ": string", "required": false, "schema": { "title": "distinguishedName", "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": "/restPolicyPolicyDefinitionGetSyncTaskResult" }, "task": true }, { "name": "restPolicyPolicyDefinitionResetToReleasedPolicy", "summary": "resetToReleasedPolicy", "description": "Reset the global policy to the most recent released policy. The local policies are not affected. Intention : MODIFIER resetToReleasedPolicy: instance-level modifier API resetToReleasedPolicy of class policy.PolicyDefinition DescendantInfo: rtr.SegmentRoutingMaintenancePolicy DescendantInfo: lte5g.PcfIdList DescendantInfo: mplstp.BFDTemplate DescendantInfo: ixrqos.VlanQosPolicy DescendantInfo: ressubscr.ShcvPolicy DescendantInfo: ltepolicyoptions.AssumePositiveActionProfile Desc...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restPolicyPolicyDefinitionResetToReleasedPolicy" }, "task": true }, { "name": "restPolicyPolicyDefinitionSetConfigurationModeToDraft", "summary": "setConfigurationModeToDraft", "description": "Set configuration mode to Draft. It is only applicable for the global policy. Intention : MODIFIER setConfigurationModeToDraft: instance-level modifier API setConfigurationModeToDraft of class policy.PolicyDefinition DescendantInfo: rtr.SegmentRoutingMaintenancePolicy DescendantInfo: lte5g.PcfIdList DescendantInfo: mplstp.BFDTemplate DescendantInfo: ixrqos.VlanQosPolicy DescendantInfo: ressubscr.ShcvPolicy DescendantInfo: ltepolicyoptions.AssumePositiveActionProfile DescendantI...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restPolicyPolicyDefinitionSetConfigurationModeToDraft" }, "task": true }, { "name": "restPolicyPolicyDefinitionSetConfigurationModeToReleased", "summary": "setConfigurationModeToReleased", "description": "Sets the configuration mode to Released and distributes the global policy to the local definitions network-wide. It is only applicable for the global policy. Intention : MODIFIER setConfigurationModeToReleased: instance-level modifier API setConfigurationModeToReleased of class policy.PolicyDefinition DescendantInfo: rtr.SegmentRoutingMaintenancePolicy DescendantInfo: lte5g.PcfIdList DescendantInfo: mplstp.BFDTemplate DescendantInfo: ixrqos.VlanQosPolicy DescendantInfo: ressubscr....(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restPolicyPolicyDefinitionSetConfigurationModeToReleased" }, "task": true }, { "name": "restPolicyPolicyDefinitionSetDistributionModeToLocalEditOnly", "summary": "setDistributionModeToLocalEditOnly", "description": "Set distribution mode to local edit only for local policies on the sites specified by siteIds. If it is called from the local policy, only that local policy is updated. Intention : MODIFIER setDistributionModeToLocalEditOnly: instance-level modifier API setDistributionModeToLocalEditOnly of class policy.PolicyDefinition DescendantInfo: rtr.SegmentRoutingMaintenancePolicy DescendantInfo: lte5g.PcfIdList DescendantInfo: mplstp.BFDTemplate DescendantInfo: ixrqos.VlanQosPolicy Descenda...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restPolicyPolicyDefinitionSetDistributionModeToLocalEditOnly" }, "task": true }, { "name": "restPolicyPolicyDefinitionSetDistributionModeToSyncWithGlobal", "summary": "setDistributionModeToSyncWithGlobal", "description": "Set distribution mode to Sync with Global for local policies on the sites specified by siteIds. It automatically synchronize local policies with the most recent released global policy. If it is called from the local policy, only that local policy is updated. Intention : MODIFIER setDistributionModeToSyncWithGlobal: instance-level modifier API setDistributionModeToSyncWithGlobal of class policy.PolicyDefinition DescendantInfo: rtr.SegmentRoutingMaintenancePolicy DescendantInfo: lte5g.Pcf...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restPolicyPolicyDefinitionSetDistributionModeToSyncWithGlobal" }, "task": true }, { "name": "restPolicyPolicyDefinitionSyncTo", "summary": "syncTo", "description": "If it is called from global policy, the selected local policy is copied into this global policy. If configuration mode is not used, the synchronized global policy is distributed to existing local definitions network-wide. If it is called from the local policy, the selected local policy is copied into this local policy and applied to the network. Intention : MODIFIER syncTo: instance-level modifier API syncTo of class policy.PolicyDefinition DescendantInfo: rtr.SegmentRoutingMaintenancePol...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restPolicyPolicyDefinitionSyncTo" }, "task": true }, { "name": "restPolicyPolicyDefinitionSyncToLocalWithResync", "summary": "syncToLocalWithResync", "description": "Is called from the local policy,resync of the local policy is done before the selected local policy is copied into this local policy and applied to the network. Intention : MODIFIER syncToLocalWithResync: instance-level modifier API syncToLocalWithResync of class policy.PolicyDefinition DescendantInfo: rtr.SegmentRoutingMaintenancePolicy DescendantInfo: lte5g.PcfIdList DescendantInfo: mplstp.BFDTemplate DescendantInfo: ixrqos.VlanQosPolicy DescendantInfo: ressubscr.ShcvPolicy Des...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restPolicyPolicyDefinitionSyncToLocalWithResync" }, "task": true }, { "name": "restPolicyPolicyDistributeGroupAddNetworkElementsToGroup", "summary": "rest_policy_PolicyDistributeGroup_addNetworkElementsToGroup", "description": "rest_policy_PolicyDistributeGroup_addNetworkElementsToGroup", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restPolicyPolicyDistributeGroupAddNetworkElementsToGroup" }, "task": true }, { "name": "restPolicyPolicyDistributeGroupRemoveNetworkElementsFromGroup", "summary": "rest_policy_PolicyDistributeGroup_removeNetworkElementsFromGroup", "description": "rest_policy_PolicyDistributeGroup_removeNetworkElementsFromGroup", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restPolicyPolicyDistributeGroupRemoveNetworkElementsFromGroup" }, "task": true }, { "name": "restPolicyPolicyDistributeGroupManagerFindPolicyDistributeGroups", "summary": "findPolicyDistributeGroups", "description": "Intention : RETRIEVER findPolicyDistributeGroups: class-level [object finder] (retriever) API findPolicyDistributeGroups on default instance pdg-mgr of class policy.PolicyDistributeGroupManager", "input": [ { "name": "aInNetworkElementOrSiteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInNetworkElementOrSiteId", "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": "/restPolicyPolicyDistributeGroupManagerFindPolicyDistributeGroups" }, "task": true }, { "name": "restPolicyPolicySyncGroupAddClasses", "summary": "rest_policy_PolicySyncGroup_addClasses", "description": "rest_policy_PolicySyncGroup_addClasses", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restPolicyPolicySyncGroupAddClasses" }, "task": true }, { "name": "restPolicyPolicySyncGroupAddMembers", "summary": "rest_policy_PolicySyncGroup_addMembers", "description": "rest_policy_PolicySyncGroup_addMembers", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"action\": \"string\", \"globalPolicyFullNames\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "action", "globalPolicyFullNames" ], "properties": { "action": { "type": "string", "description": " " }, "globalPolicyFullNames": { "type": "array", "description": " ", "items": { "type": "string" } } }, "description": "Model containing the method level model for PolicySyncGroup.addMembers to decode json data to internal NFM-P object model" } } ], "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": "/restPolicyPolicySyncGroupAddMembers" }, "task": true }, { "name": "restPolicyPolicySyncGroupAddToMembers", "summary": "addToMembers", "description": "Add the master policy contents to members. Intention : MODIFIER addToMembers: instance-level modifier API addToMembers of class policy.PolicySyncGroup instanceFullName : distinguished/instance name of called object The updated member list.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restPolicyPolicySyncGroupAddToMembers" }, "task": true }, { "name": "restPolicyPolicySyncGroupAudit", "summary": "rest_policy_PolicySyncGroup_audit", "description": "rest_policy_PolicySyncGroup_audit", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restPolicyPolicySyncGroupAudit" }, "task": true }, { "name": "restPolicyPolicySyncGroupDeleteClasses", "summary": "rest_policy_PolicySyncGroup_deleteClasses", "description": "rest_policy_PolicySyncGroup_deleteClasses", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restPolicyPolicySyncGroupDeleteClasses" }, "task": true }, { "name": "restPolicyPolicySyncGroupDeleteMembers", "summary": "rest_policy_PolicySyncGroup_deleteMembers", "description": "rest_policy_PolicySyncGroup_deleteMembers", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restPolicyPolicySyncGroupDeleteMembers" }, "task": true }, { "name": "restPolicyPolicySyncGroupSyncMembers", "summary": "syncMembers", "description": "Sync the master policy contents to members. Intention : MODIFIER syncMembers: instance-level modifier API syncMembers of class policy.PolicySyncGroup instanceFullName : distinguished/instance name of called object The updated member list.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restPolicyPolicySyncGroupSyncMembers" }, "task": true }, { "name": "restPolicyPolicySyncGroupUpdateMaster", "summary": "updateMaster", "description": "Add and update the selected global AAGroupPolicy contents to master policy. Intention : MODIFIER updateMaster: instance-level modifier API updateMaster of class policy.PolicySyncGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restPolicyPolicySyncGroupUpdateMaster" }, "task": true }, { "name": "restPolicytestutilBGPPolicyTestUtilityManagerExecute", "summary": "rest_policytestutil_BGPPolicyTestUtilityManager_execute", "description": "rest_policytestutil_BGPPolicyTestUtilityManager_execute", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restPolicytestutilBGPPolicyTestUtilityManagerExecute" }, "task": true }, { "name": "restPppoeMlpppBundleRetrieveMlpppBundles", "summary": "retrieveMlpppBundles", "description": "Method used to retrieve Retrieving MLPPP Bundle(s) from NE. Intention : RETRIEVER retrieveMlpppBundles: class-level retriever API retrieveMlpppBundles of class pppoe.MlpppBundle", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"bundleId\": 123, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "bundleId", "objectClassName", "siteId", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "bundleId": { "type": "integer" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct RetrievingMlpppBundleStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restPppoeMlpppBundleRetrieveMlpppBundles" }, "task": true }, { "name": "restPppoePPPPolicyRemovePppDefaultPassword", "summary": "rest_pppoe_PPPPolicy_removePppDefaultPassword", "description": "rest_pppoe_PPPPolicy_removePppDefaultPassword", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restPppoePPPPolicyRemovePppDefaultPassword" }, "task": true }, { "name": "restPppoePPPSessionRetrievePppSessions", "summary": "retrievePppSessions", "description": "Method used to retrieve a PPP session from NE. Intention : RETRIEVER retrievePppSessions: class-level retriever API retrievePppSessions of class pppoe.PPPSession", "input": [ { "name": "body", "type": "object", "info": ": {\"aInCircuitId\": \"string\", \"aInRemoteId\": \"string\", \"pppSessionRetrievalStruct\": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"serviceId\": 123, \"pppSessionIndex\": 123, \"timeout\": 123}, \"retrieveManagedRoutes\": \"boolean\", \"retrieveQoSOvr\": \"boolean\", \"retrieveAcclpEncap\": \"boolean\", \"retrieveBgpPeerInfo\": \"boolean\", \"retrieveBgpPeerV6Info\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "pppSessionRetrievalStruct", "retrieveAcclpEncap", "retrieveBgpPeerInfo", "retrieveBgpPeerV6Info", "retrieveManagedRoutes", "retrieveQoSOvr" ], "properties": { "aInCircuitId": { "type": "string" }, "aInRemoteId": { "type": "string" }, "pppSessionRetrievalStruct": { "type": "object", "required": [ "objectClassName", "pppSessionIndex", "serviceId", "siteId", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "serviceId": { "type": "integer" }, "pppSessionIndex": { "type": "integer" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct PppSessionRetrievalStruct. to decode json data to internal NFM-P object model" }, "retrieveManagedRoutes": { "type": "boolean", "description": " Specifies if Managed Routes should be retrieved,the default is \"true\".The Managed Routes won't be retrieved if Service preferences \"retrieveManagedRoutes\" isfalse. default:true", "default": false }, "retrieveQoSOvr": { "type": "boolean", "description": " Specifies if QoS Override should be retrieved,the default is \"true\".The QoS Override won't be retrieved if Service preferences \"retrieveQoSOvr\" is false. default:true", "default": false }, "retrieveAcclpEncap": { "type": "boolean", "description": " Specifies if Access Loop Encapsulation should be retrieved,the default is \"true\".The Access Loop Encapsulation won't be retrieved if Service preferences \"retrieveAcclpEncap\" is false. default:true", "default": false }, "retrieveBgpPeerInfo": { "type": "boolean", "description": " Specifies if IPv4 BGP Peer Info should be retrieved,the default is \"true\".The BGP Peer Info won't be retrieved if System Preferences \"retrieveBgpPeerInfo\" isfalse. default:true", "default": false }, "retrieveBgpPeerV6Info": { "type": "boolean", "description": " Specifies if IPv6 BGP Peer Info should be retrieved,the default is \"true\".The BGP Peer Info won't be retrieved if System Preferences \"retrieveBgpPeerV6Info\" isfalse. default:true", "default": false } }, "description": "Model containing the method level model for PPPSession.retrievePppSessions to decode json data to internal NFM-P object model" } } ], "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": "/restPppoePPPSessionRetrievePppSessions" }, "task": true }, { "name": "restPppoePPPSessionRadiusClassAttributeRetrievePPPSessionRadiusClasses", "summary": "retrievePPPSessionRadiusClasses", "description": "Method used to query the NE for the PPP Session RADIUS Class Attributes related to the specified PPP Session. Intention : RETRIEVER retrievePPPSessionRadiusClasses: class-level retriever API retrievePPPSessionRadiusClasses of class pppoe.PPPSessionRadiusClassAttribute", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"sessionIndex\": 123, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "sessionIndex", "siteId", "timeout" ], "properties": { "siteId": { "type": "string", "description": " Site ID for the PPP Session." }, "sessionIndex": { "type": "integer", "description": " PPP Session ID." }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait before receiving the results.This is an optional input parameter. The default value is 5 minutes (300000). default:300000" } }, "description": "Model containing the method level model for PPPSessionRadiusClassAttribute.retrievePPPSessionRadiusClasses to decode json data to internal NFM-P object model" } } ], "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": "/restPppoePPPSessionRadiusClassAttributeRetrievePPPSessionRadiusClasses" }, "task": true }, { "name": "restPppoePPPoASessionRetrievePPPoASessions", "summary": "retrievePPPoASessions", "description": "Method used to query the NE for the PPPoA session(s) for. Intention : RETRIEVER retrievePPPoASessions: class-level retriever API retrievePPPoASessions of class pppoe.PPPoASession", "input": [ { "name": "body", "type": "object", "info": ": {\"aInCircuitId\": \"string\", \"aInRemoteId\": \"string\", \"retrievingSessionStruct\": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"svcId\": 123, \"sapId\": \"string\", \"innerEncap\": 123, \"outerEncap\": 123, \"sessionsMac\": \"string\", \"sessionsId\": 123, \"timeout\": 123}, \"retrieveManagedRoutes\": \"boolean\", \"retrieveQoSOvr\": \"boolean\", \"retrieveAcclpEncap\": \"boolean\", \"retrieveBgpPeerInfo\": \"boolean\", \"retrieveBgpPeerV6Info\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "retrieveAcclpEncap", "retrieveBgpPeerInfo", "retrieveBgpPeerV6Info", "retrieveManagedRoutes", "retrieveQoSOvr", "retrievingSessionStruct" ], "properties": { "aInCircuitId": { "type": "string" }, "aInRemoteId": { "type": "string" }, "retrievingSessionStruct": { "type": "object", "required": [ "innerEncap", "objectClassName", "outerEncap", "sapId", "sessionsId", "sessionsMac", "siteId", "svcId", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "svcId": { "type": "integer" }, "sapId": { "type": "string" }, "innerEncap": { "type": "integer" }, "outerEncap": { "type": "integer" }, "sessionsMac": { "type": "string" }, "sessionsId": { "type": "integer" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct RetrievingSessionStruct. to decode json data to internal NFM-P object model" }, "retrieveManagedRoutes": { "type": "boolean", "description": " Specifies if Managed Routes should be retrieved,the default is \"true\".The Managed Routes won't be retrieved if Service preferences \"retrieveManagedRoutes\" isfalse. default:true", "default": false }, "retrieveQoSOvr": { "type": "boolean", "description": " Specifies if QoS Override should be retrieved,the default is \"true\".The QoS Override won't be retrieved if Service preferences \"retrieveQoSOvr\" is false. default:true", "default": false }, "retrieveAcclpEncap": { "type": "boolean", "description": " Specifies if Access Loop Encapsulation should be retrieved,the default is \"true\".The Access Loop Encapsulation won't be retrieved if Service preferences \"retrieveAcclpEncap\" is false. default:true", "default": false }, "retrieveBgpPeerInfo": { "type": "boolean", "description": " Specifies if Ipv4 BGP Peer Info should be retrieved,the default is \"true\".The BGP Peer Info won't be retrieved if System Preferences \"retrieveBgpPeerInfo\" isfalse. default:true", "default": false }, "retrieveBgpPeerV6Info": { "type": "boolean", "description": " Specifies if Ipv6 BGP Peer Info should be retrieved,the default is \"true\".The BGP Peer Info won't be retrieved if System Preferences \"retrieveBgpPeerV6Info\" isfalse. default:true", "default": false } }, "description": "Model containing the method level model for PPPoASession.retrievePPPoASessions to decode json data to internal NFM-P object model" } } ], "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": "/restPppoePPPoASessionRetrievePPPoASessions" }, "task": true }, { "name": "restPppoePPPoESessionRetrievePPPoESessions", "summary": "retrievePPPoESessions", "description": "Method used to query the NE for the PPPoE session(s) for. Intention : RETRIEVER retrievePPPoESessions: class-level retriever API retrievePPPoESessions of class pppoe.PPPoESession", "input": [ { "name": "body", "type": "object", "info": ": {\"aInCircuitId\": \"string\", \"aInRemoteId\": \"string\", \"retrievingSessionStruct\": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"svcId\": 123, \"sapId\": \"string\", \"innerEncap\": 123, \"outerEncap\": 123, \"sessionsMac\": \"string\", \"sessionsId\": 123, \"timeout\": 123}, \"shallowRetrieval\": \"boolean\", \"retrieveL2tpPeerAddress\": \"boolean\", \"retrieveManagedRoutes\": \"boolean\", \"retrieveQoSOvr\": \"boolean\", \"retrieveAcclpEncap\": \"boolean\", \"retrieveBgpPeerInfo\": \"boolean\", \"retrieveBgpPeerV6Info\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "retrieveAcclpEncap", "retrieveBgpPeerInfo", "retrieveBgpPeerV6Info", "retrieveL2tpPeerAddress", "retrieveManagedRoutes", "retrieveQoSOvr", "retrievingSessionStruct", "shallowRetrieval" ], "properties": { "aInCircuitId": { "type": "string" }, "aInRemoteId": { "type": "string" }, "retrievingSessionStruct": { "type": "object", "required": [ "innerEncap", "objectClassName", "outerEncap", "sapId", "sessionsId", "sessionsMac", "siteId", "svcId", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "svcId": { "type": "integer" }, "sapId": { "type": "string" }, "innerEncap": { "type": "integer" }, "outerEncap": { "type": "integer" }, "sessionsMac": { "type": "string" }, "sessionsId": { "type": "integer" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct RetrievingSessionStruct. to decode json data to internal NFM-P object model" }, "shallowRetrieval": { "type": "boolean", "description": " If it is true, not all of the properties are retrieved for quick response default:false", "default": false }, "retrieveL2tpPeerAddress": { "type": "boolean", "description": " Specifies if l2tpPeerAddress should be retrieved,the default is \"false\". default:false", "default": false }, "retrieveManagedRoutes": { "type": "boolean", "description": " Specifies if Managed Routes should be retrieved,the default is \"true\".The Managed Routes won't be retrieved if Service preferences \"retrieveManagedRoutes\" is false. default:true", "default": false }, "retrieveQoSOvr": { "type": "boolean", "description": " Specifies if QoS Override should be retrieved,the default is \"true\".The QoS Override won't be retrieved if Service preferences \"retrieveQoSOvr\" is false. default:true", "default": false }, "retrieveAcclpEncap": { "type": "boolean", "description": " Specifies if Access Loop Encapsulation should be retrieved,the default is \"true\".The Access Loop Encapsulation won't be retrieved if Service preferences \"retrieveAcclpEncap\" is false. default:true", "default": false }, "retrieveBgpPeerInfo": { "type": "boolean", "description": " Specifies if IPv4 BGP Peer Info should be retrieved,the default is \"true\".The BGP Peer Info won't be retrieved if System Preferences \"retrieveBgpPeerInfo\" isfalse. default:true", "default": false }, "retrieveBgpPeerV6Info": { "type": "boolean", "description": " Specifies if IPv6 BGP Peer Info should be retrieved,the default is \"true\".The BGP Peer Info won't be retrieved if System Preferences \"retrieveBgpPeerV6Info\" isfalse. default:true", "default": false } }, "description": "Model containing the method level model for PPPoESession.retrievePPPoESessions to decode json data to internal NFM-P object model" } } ], "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": "/restPppoePPPoESessionRetrievePPPoESessions" }, "task": true }, { "name": "restPropertyrulesPropertyValuePolicyAssignGroups", "summary": "rest_propertyrules_PropertyValuePolicy_assignGroups", "description": "rest_propertyrules_PropertyValuePolicy_assignGroups", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restPropertyrulesPropertyValuePolicyAssignGroups" }, "task": true }, { "name": "restPropertyrulesPropertyValuePolicyAssignUsers", "summary": "rest_propertyrules_PropertyValuePolicy_assignUsers", "description": "rest_propertyrules_PropertyValuePolicy_assignUsers", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restPropertyrulesPropertyValuePolicyAssignUsers" }, "task": true }, { "name": "restPropertyrulesPropertyValuePolicyUnassignGroups", "summary": "rest_propertyrules_PropertyValuePolicy_unassignGroups", "description": "rest_propertyrules_PropertyValuePolicy_unassignGroups", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restPropertyrulesPropertyValuePolicyUnassignGroups" }, "task": true }, { "name": "restPropertyrulesPropertyValuePolicyUnassignUsers", "summary": "rest_propertyrules_PropertyValuePolicy_unassignUsers", "description": "rest_propertyrules_PropertyValuePolicy_unassignUsers", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restPropertyrulesPropertyValuePolicyUnassignUsers" }, "task": true }, { "name": "restPtpIEEEPTPPeerResetPTPCounters", "summary": "rest_ptp_IEEEPTPPeer_resetPTPCounters", "description": "rest_ptp_IEEEPTPPeer_resetPTPCounters", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restPtpIEEEPTPPeerResetPTPCounters" }, "task": true }, { "name": "restPtpIEEEPTPSyncDomainFindPtpPeers", "summary": "rest_ptp_IEEEPTPSyncDomain_findPtpPeers", "description": "rest_ptp_IEEEPTPSyncDomain_findPtpPeers", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInDomain\": 123, \"aInIsUnmonitoredIp\": \"boolean\", \"aInIsUnmonitoredBidirIp\": \"boolean\"}", "required": false, "schema": { "type": "object", "properties": { "aInDomain": { "type": "integer" }, "aInIsUnmonitoredIp": { "type": "boolean", "default": false }, "aInIsUnmonitoredBidirIp": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for IEEEPTPSyncDomain.findPtpPeers to decode json data to internal NFM-P object model" } } ], "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": "/restPtpIEEEPTPSyncDomainFindPtpPeers" }, "task": true }, { "name": "restPtpIEEEPTPSyncManagerCreateBidirMonitoredIpPath", "summary": "rest_ptp_IEEEPTPSyncManager_createBidirMonitoredIpPath", "description": "rest_ptp_IEEEPTPSyncManager_createBidirMonitoredIpPath", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restPtpIEEEPTPSyncManagerCreateBidirMonitoredIpPath" }, "task": true }, { "name": "restPtpIEEEPTPSyncManagerCreateMonitoredIpPath", "summary": "rest_ptp_IEEEPTPSyncManager_createMonitoredIpPath", "description": "rest_ptp_IEEEPTPSyncManager_createMonitoredIpPath", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restPtpIEEEPTPSyncManagerCreateMonitoredIpPath" }, "task": true }, { "name": "restPxcPortCrossConnectGetDependencyCount", "summary": "getDependencyCount", "description": "Intention : RETRIEVER getDependencyCount: instance-level retriever API getDependencyCount of class pxc.PortCrossConnect instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restPxcPortCrossConnectGetDependencyCount" }, "task": true }, { "name": "restPxcPortCrossConnectSubPortRequestClearEfmOamEventLogs", "summary": "requestClearEfmOamEventLogs", "description": "Request clearing of EFM-OAM Event Logs. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearEfmOamEventLogs: instance-level modifier API requestClearEfmOamEventLogs of class pxc.PortCrossConnectSubPort instanceFullName : distinguished/instance name of...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restPxcPortCrossConnectSubPortRequestClearEfmOamEventLogs" }, "task": true }, { "name": "restPxcPortCrossConnectSubPortRequestResyncEfmOamEventLogs", "summary": "rest_pxc_PortCrossConnectSubPort_requestResyncEfmOamEventLogs", "description": "rest_pxc_PortCrossConnectSubPort_requestResyncEfmOamEventLogs", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restPxcPortCrossConnectSubPortRequestResyncEfmOamEventLogs" }, "task": true }, { "name": "restPxcPortCrossConnectSubPortRequestResyncEfmOamEventStats", "summary": "rest_pxc_PortCrossConnectSubPort_requestResyncEfmOamEventStats", "description": "rest_pxc_PortCrossConnectSubPort_requestResyncEfmOamEventStats", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restPxcPortCrossConnectSubPortRequestResyncEfmOamEventStats" }, "task": true }, { "name": "restPxcPortCrossConnectSubPortRequestResyncEfmOamPeerInfo", "summary": "rest_pxc_PortCrossConnectSubPort_requestResyncEfmOamPeerInfo", "description": "rest_pxc_PortCrossConnectSubPort_requestResyncEfmOamPeerInfo", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restPxcPortCrossConnectSubPortRequestResyncEfmOamPeerInfo" }, "task": true }, { "name": "restQosprofileMcfrEgressQosProfileClassesResetToDefault", "summary": "rest_qosprofile_McfrEgressQosProfile_classesResetToDefault", "description": "rest_qosprofile_McfrEgressQosProfile_classesResetToDefault", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restQosprofileMcfrEgressQosProfileClassesResetToDefault" }, "task": true }, { "name": "restQosprofileMcfrEgressQosProfileFindMcfrBundles", "summary": "findMcfrBundles", "description": "Finds the MCFR bundles using the McfrEgressQosProfile. Intention : RETRIEVER findMcfrBundles: instance-level [object finder] (retriever) API findMcfrBundles of class qosprofile.McfrEgressQosProfile instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restQosprofileMcfrEgressQosProfileFindMcfrBundles" }, "task": true }, { "name": "restQosprofileMcfrIngressQosProfileClassesResetToDefault", "summary": "rest_qosprofile_McfrIngressQosProfile_classesResetToDefault", "description": "rest_qosprofile_McfrIngressQosProfile_classesResetToDefault", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restQosprofileMcfrIngressQosProfileClassesResetToDefault" }, "task": true }, { "name": "restQosprofileMcfrIngressQosProfileFindMcfrBundles", "summary": "findMcfrBundles", "description": "Finds the MCFR bundles using the McfrIngressQosProfile. Intention : RETRIEVER findMcfrBundles: instance-level [object finder] (retriever) API findMcfrBundles of class qosprofile.McfrIngressQosProfile instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restQosprofileMcfrIngressQosProfileFindMcfrBundles" }, "task": true }, { "name": "restQosprofileMlpppEgressQosProfileFCsResetToDefault", "summary": "rest_qosprofile_MlpppEgressQosProfile_FCsResetToDefault", "description": "rest_qosprofile_MlpppEgressQosProfile_FCsResetToDefault", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restQosprofileMlpppEgressQosProfileFCsResetToDefault" }, "task": true }, { "name": "restQosprofileMlpppEgressQosProfileClassesResetToDefault", "summary": "rest_qosprofile_MlpppEgressQosProfile_classesResetToDefault", "description": "rest_qosprofile_MlpppEgressQosProfile_classesResetToDefault", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restQosprofileMlpppEgressQosProfileClassesResetToDefault" }, "task": true }, { "name": "restQosprofileMlpppEgressQosProfileFindMlpppBundles", "summary": "findMlpppBundles", "description": "Finds the MLPPP bundles using the MlpppEgressQosProfile. Intention : RETRIEVER findMlpppBundles: instance-level [object finder] (retriever) API findMlpppBundles of class qosprofile.MlpppEgressQosProfile instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restQosprofileMlpppEgressQosProfileFindMlpppBundles" }, "task": true }, { "name": "restQosprofileMlpppIngressQosProfileClassesResetToDefault", "summary": "rest_qosprofile_MlpppIngressQosProfile_classesResetToDefault", "description": "rest_qosprofile_MlpppIngressQosProfile_classesResetToDefault", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restQosprofileMlpppIngressQosProfileClassesResetToDefault" }, "task": true }, { "name": "restQosprofileMlpppIngressQosProfileFindMlpppBundles", "summary": "findMlpppBundles", "description": "Finds the MLPPP bundles using the MlpppIngressQosProfile. Intention : RETRIEVER findMlpppBundles: instance-level [object finder] (retriever) API findMlpppBundles of class qosprofile.MlpppIngressQosProfile instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restQosprofileMlpppIngressQosProfileFindMlpppBundles" }, "task": true }, { "name": "restRadiusaccountingPolicyFindVPRNInstances", "summary": "findVPRNInstances", "description": "finds VPRN Instances that have site configured. Intention : RETRIEVER findVPRNInstances: class-level [object finder] (retriever) API findVPRNInstances of class radiusaccounting.Policy", "input": [ { "name": "aInSiteID", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInSiteID", "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": "/restRadiusaccountingPolicyFindVPRNInstances" }, "task": true }, { "name": "restRanlicenseRANLicenseManagerGetLicenseUsage", "summary": "getLicenseUsage", "description": "Synchronize NeLicense Service from Config Objects Intention : MODIFIER getLicenseUsage: instance-level modifier API getLicenseUsage on default instance rlm-mgr of class ranlicense.RANLicenseManager", "input": [ { "name": "licenseFileName", "type": "string", "info": ": string", "required": false, "schema": { "title": "licenseFileName", "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": "/restRanlicenseRANLicenseManagerGetLicenseUsage" }, "task": true }, { "name": "restRanlicenseRANLicenseManagerImportRANLicenses", "summary": "rest_ranlicense_RANLicenseManager_importRANLicenses", "description": "rest_ranlicense_RANLicenseManager_importRANLicenses", "input": [ { "name": "body", "type": "object", "info": ": {\"licenseFileName\": \"string\", \"clientIpAddressSource\": \"string\", \"clientUserNameSource\": \"string\", \"licenseFileContents\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "clientIpAddressSource", "clientUserNameSource", "licenseFileContents", "licenseFileName" ], "properties": { "licenseFileName": { "type": "string", "description": " " }, "clientIpAddressSource": { "type": "string", "description": " " }, "clientUserNameSource": { "type": "string", "description": " " }, "licenseFileContents": { "type": "string", "description": " " } }, "description": "Model containing the method level model for RANLicenseManager.importRANLicenses to decode json data to internal NFM-P object model" } } ], "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": "/restRanlicenseRANLicenseManagerImportRANLicenses" }, "task": true }, { "name": "restRanlicenseRANLicenseManagerReloadRANLicenses", "summary": "rest_ranlicense_RANLicenseManager_reloadRANLicenses", "description": "rest_ranlicense_RANLicenseManager_reloadRANLicenses", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restRanlicenseRANLicenseManagerReloadRANLicenses" }, "task": true }, { "name": "restRanlicenseRANLicenseManagerSynchronizeNeLicenseServiceFromConfigObjects", "summary": "rest_ranlicense_RANLicenseManager_synchronizeNeLicenseServiceFromConfigObjects", "description": "rest_ranlicense_RANLicenseManager_synchronizeNeLicenseServiceFromConfigObjects", "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": "/restRanlicenseRANLicenseManagerSynchronizeNeLicenseServiceFromConfigObjects" }, "task": true }, { "name": "restRanradiomRANRadioMeasureManagerFindEnodeBsReadyForRadioMeasurement", "summary": "findEnodeBsReadyForRadioMeasurement", "description": "Returns the enodebs ok for a radio measurement action Intention : RETRIEVER findEnodeBsReadyForRadioMeasurement: instance-level [object finder] (retriever) API findEnodeBsReadyForRadioMeasurement on default instance radiomgr of class ranradiom.RANRadioMeasureManager", "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": "/restRanradiomRANRadioMeasureManagerFindEnodeBsReadyForRadioMeasurement" }, "task": true }, { "name": "restRanradiomRANRadioMeasureManagerRefreshEnodeB", "summary": "rest_ranradiom_RANRadioMeasureManager_refreshEnodeB", "description": "rest_ranradiom_RANRadioMeasureManager_refreshEnodeB", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restRanradiomRANRadioMeasureManagerRefreshEnodeB" }, "task": true }, { "name": "restRanradiomRANRadioMeasureManagerRefreshEnodeBWithResult", "summary": "refreshEnodeBWithResult", "description": "Launch enodeb radio measurement refresh Intention : MODIFIER refreshEnodeBWithResult: instance-level modifier API refreshEnodeBWithResult on default instance radiomgr of class ranradiom.RANRadioMeasureManager", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restRanradiomRANRadioMeasureManagerRefreshEnodeBWithResult" }, "task": true }, { "name": "restRanradiomRANRadioMeasureManagerStartPolling", "summary": "rest_ranradiom_RANRadioMeasureManager_startPolling", "description": "rest_ranradiom_RANRadioMeasureManager_startPolling", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restRanradiomRANRadioMeasureManagerStartPolling" }, "task": true }, { "name": "restRanradiomRANRadioMeasureManagerStartPollingWithResult", "summary": "startPollingWithResult", "description": "This operation results in starting to poll the radio measurement table. Intention : MODIFIER startPollingWithResult: instance-level modifier API startPollingWithResult on default instance radiomgr of class ranradiom.RANRadioMeasureManager", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restRanradiomRANRadioMeasureManagerStartPollingWithResult" }, "task": true }, { "name": "restRanradiomRANRadioMeasureManagerStopPolling", "summary": "rest_ranradiom_RANRadioMeasureManager_stopPolling", "description": "rest_ranradiom_RANRadioMeasureManager_stopPolling", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restRanradiomRANRadioMeasureManagerStopPolling" }, "task": true }, { "name": "restRcaRcaManagerAsyncCheckConfig", "summary": "rest_rca_RcaManager_asyncCheckConfig", "description": "rest_rca_RcaManager_asyncCheckConfig", "input": [ { "name": "body", "type": "object", "info": ": {\"aInContext\": {\"objectClassName\": \"string\", \"depth\": 123, \"appDefinedContext\": \"object\", \"time\": 123}, \"aInFdn\": \"string\", \"fdnPolicy\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "fdnPolicy" ], "properties": { "aInContext": { "type": "object", "required": [ "appDefinedContext", "depth", "objectClassName", "time" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "depth": { "type": "integer" }, "appDefinedContext": { "type": "object" }, "time": { "type": "integer" } }, "description": "Model containing the method level model for struct Context. to decode json data to internal NFM-P object model" }, "aInFdn": { "type": "string" }, "fdnPolicy": { "type": "string", "description": " The FDN of Audit policy which it will be used, it can null." } }, "description": "Model containing the method level model for RcaManager.asyncCheckConfig to decode json data to internal NFM-P object model" } } ], "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": "/restRcaRcaManagerAsyncCheckConfig" }, "task": true }, { "name": "restRcaRcaManagerCheckConfig", "summary": "checkConfig", "description": "call validate on the object Intention : MODIFIER checkConfig: class-level modifier API checkConfig on default instance rca-mgr of class rca.RcaManager", "input": [ { "name": "body", "type": "object", "info": ": {\"aInContext\": {\"objectClassName\": \"string\", \"depth\": 123, \"appDefinedContext\": \"object\", \"time\": 123}, \"fdn\": \"string\", \"fdnPolicy\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "fdn", "fdnPolicy" ], "properties": { "aInContext": { "type": "object", "required": [ "appDefinedContext", "depth", "objectClassName", "time" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "depth": { "type": "integer" }, "appDefinedContext": { "type": "object" }, "time": { "type": "integer" } }, "description": "Model containing the method level model for struct Context. to decode json data to internal NFM-P object model" }, "fdn": { "type": "string", "description": " The source of the managed object which validate will be started." }, "fdnPolicy": { "type": "string", "description": " The FDN of Audit policy which it will be used, it can null." } }, "description": "Model containing the method level model for RcaManager.checkConfig to decode json data to internal NFM-P object model" } } ], "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": "/restRcaRcaManagerCheckConfig" }, "task": true }, { "name": "restRcaRcaManagerDeleteProblems", "summary": "rest_rca_RcaManager_deleteProblems", "description": "rest_rca_RcaManager_deleteProblems", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restRcaRcaManagerDeleteProblems" }, "task": true }, { "name": "restRcaRcaManagerFixProblem", "summary": "fixProblem", "description": "call to fix the problem on the object Intention : RETRIEVER fixProblem: class-level retriever API fixProblem on default instance rca-mgr of class rca.RcaManager", "input": [ { "name": "body", "type": "object", "info": ": {\"aInPreFixData\": {\"objectClassName\": \"string\", \"state\": \"string\", \"appDefinedContext\": \"object\", \"plan\": \"array\", \"report\": \"array\"}, \"fdn\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "fdn" ], "properties": { "aInPreFixData": { "type": "object", "required": [ "appDefinedContext", "objectClassName", "plan", "report", "state" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "state": { "type": "string" }, "appDefinedContext": { "type": "object" }, "plan": { "type": "array", "items": { "type": "string" } }, "report": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PreFixData. to decode json data to internal NFM-P object model" }, "fdn": { "type": "string", "description": " The Fdn of Problem Object." } }, "description": "Model containing the method level model for RcaManager.fixProblem to decode json data to internal NFM-P object model" } } ], "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": "/restRcaRcaManagerFixProblem" }, "task": true }, { "name": "restRcaRcaManagerPreFixProblem", "summary": "preFixProblem", "description": "call to show what will be impact by fixing this problem or can be fixed. Intention : MODIFIER preFixProblem: class-level modifier API preFixProblem on default instance rca-mgr of class rca.RcaManager", "input": [ { "name": "body", "type": "object", "info": ": {\"aInPreFixData\": {\"objectClassName\": \"string\", \"state\": \"string\", \"appDefinedContext\": \"object\", \"plan\": \"array\", \"report\": \"array\"}, \"fdn\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "fdn" ], "properties": { "aInPreFixData": { "type": "object", "required": [ "appDefinedContext", "objectClassName", "plan", "report", "state" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "state": { "type": "string" }, "appDefinedContext": { "type": "object" }, "plan": { "type": "array", "items": { "type": "string" } }, "report": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PreFixData. to decode json data to internal NFM-P object model" }, "fdn": { "type": "string", "description": " The Fdn of Problem Object." } }, "description": "Model containing the method level model for RcaManager.preFixProblem to decode json data to internal NFM-P object model" } } ], "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": "/restRcaRcaManagerPreFixProblem" }, "task": true }, { "name": "restRessubscrAbstractResSubscrTemplateConstructTemplatedObject", "summary": "constructTemplatedObject", "description": "Construct object from template Intention : MODIFIER constructTemplatedObject: instance-level modifier API constructTemplatedObject of class ressubscr.AbstractResSubscrTemplate DescendantInfo: ressubscr.ResSubscrPolicyTemplate DescendantInfo: ressubscr.ResSubscrACLVelocityTemplate DescendantInfo: ressubscr.ResSubscrVelocityTemplate instanceFullName : distinguished/instance name of called object Resulting templated object.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrAbstractResSubscrTemplateConstructTemplatedObject" }, "task": true }, { "name": "restRessubscrAbstractResSubscrTemplateUpdate", "summary": "update", "description": "Method used to update this template Intention : MODIFIER update: instance-level modifier API update of class ressubscr.AbstractResSubscrTemplate DescendantInfo: ressubscr.ResSubscrPolicyTemplate DescendantInfo: ressubscr.ResSubscrACLVelocityTemplate DescendantInfo: ressubscr.ResSubscrVelocityTemplate instanceFullName : distinguished/instance name of called object List of FDNs affected Templated objects that were created from this Template", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restRessubscrAbstractResSubscrTemplateUpdate" }, "task": true }, { "name": "restRessubscrBrgProfileClearPassword", "summary": "rest_ressubscr_BrgProfile_clearPassword", "description": "rest_ressubscr_BrgProfile_clearPassword", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restRessubscrBrgProfileClearPassword" }, "task": true }, { "name": "restRessubscrDhcpLeaseStateRetrieveDhcpLease", "summary": "retrieveDhcpLease", "description": "Intention : RETRIEVER retrieveDhcpLease: class-level retriever API retrieveDhcpLease of class ressubscr.DhcpLeaseState", "input": [ { "name": "body", "type": "object", "info": ": {\"retrievingDhcpLeaseStruct\": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"svcId\": 123, \"ciAddr\": \"string\", \"chAddr\": \"string\"}, \"retrieveManagedRoutes\": \"boolean\", \"retrieveQoSOvr\": \"boolean\", \"retrieveBgpPeer\": \"boolean\", \"retrieveAcclpEncap\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "retrieveAcclpEncap", "retrieveBgpPeer", "retrieveManagedRoutes", "retrieveQoSOvr", "retrievingDhcpLeaseStruct" ], "properties": { "retrievingDhcpLeaseStruct": { "type": "object", "required": [ "chAddr", "ciAddr", "objectClassName", "siteId", "svcId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "svcId": { "type": "integer" }, "ciAddr": { "type": "string" }, "chAddr": { "type": "string" } }, "description": "Model containing the method level model for struct RetrievingDhcpLeaseStruct. to decode json data to internal NFM-P object model" }, "retrieveManagedRoutes": { "type": "boolean", "description": " Specifies if Managed Routes should be retrieved,the default is \"true\".The Managed Routes won't be retrieved if Service preferences\"retrieveManagedRoutes\"isfalse. default:true", "default": false }, "retrieveQoSOvr": { "type": "boolean", "description": " Specifies if QoS Override should be retrieved,the default is \"true\".The QoS Override won't be retrieved if Service preferences \"retrieveQoSOvr\" isfalse. default:true", "default": false }, "retrieveBgpPeer": { "type": "boolean", "description": " Specifies if BGP Peer should be retrieved,the default is \"true\".The BGP Peer won't be retrieved if Service preferences \"BGP Peer Info\" isunchecked. default:true", "default": false }, "retrieveAcclpEncap": { "type": "boolean", "description": " Specifies if Access Loop Encapsulation should be retrieved,the default is \"true\".The Access Loop Encapsulation won't be retrieved if Service preferences \"retrieveAcclpEncap\" is false. default:true", "default": false } }, "description": "Model containing the method level model for DhcpLeaseState.retrieveDhcpLease to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrDhcpLeaseStateRetrieveDhcpLease" }, "task": true }, { "name": "restRessubscrDhcpLeaseStateRadiusClassAttributeRetrieveDhcpLeaseStateRadiusClasses", "summary": "retrieveDhcpLeaseStateRadiusClasses", "description": "Method used to query the NE for the DHCP Lease State RADIUS Class Attributes related to the specified DHCP Lease State. Intention : RETRIEVER retrieveDhcpLeaseStateRadiusClasses: class-level retriever API retrieveDhcpLeaseStateRadiusClasses of class ressubscr.DhcpLeaseStateRadiusClassAttribute", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"serviceId\": 123, \"ipAddressType\": 123, \"ipAddress\": \"string\", \"clientHwAddress\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "clientHwAddress", "ipAddress", "ipAddressType", "serviceId", "siteId", "timeout" ], "properties": { "siteId": { "type": "string", "description": " Site ID for the DHCP Lease State." }, "serviceId": { "type": "integer", "description": " Service ID for service where the DHCP Lease State is." }, "ipAddressType": { "type": "integer", "description": " The IP address type of the DHCP Lease State, 1 for IPv4 or 2 for IPv6.This is an optional input parameter. If not specified, address type is inferredfrom IP address input parameter. default:0" }, "ipAddress": { "type": "string", "description": " The IP address of the DHCP Lease State." }, "clientHwAddress": { "type": "string", "description": " The Client MAC address of the DHCP lease state, e.g. xx-xx-xx-xx-xx-xx." }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait before receiving the results.This is an optional input parameter. The default value is 5 minutes (300000). default:300000" } }, "description": "Model containing the method level model for DhcpLeaseStateRadiusClassAttribute.retrieveDhcpLeaseStateRadiusClasses to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrDhcpLeaseStateRadiusClassAttributeRetrieveDhcpLeaseStateRadiusClasses" }, "task": true }, { "name": "restRessubscrHostLockoutInfoRetrieveHostLockoutInfo", "summary": "retrieveHostLockoutInfo", "description": "Method used to query a SAP for host lockout info. Intention : RETRIEVER retrieveHostLockoutInfo: class-level retriever API retrieveHostLockoutInfo of class ressubscr.HostLockoutInfo List of CommonManagedEntityInformation.", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSapPortId\": 123, \"aInSapEncapValue\": 123, \"aInSiteId\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInSapPortId": { "type": "integer" }, "aInSapEncapValue": { "type": "integer" }, "aInSiteId": { "type": "string" } }, "description": "Model containing the method level model for HostLockoutInfo.retrieveHostLockoutInfo to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrHostLockoutInfoRetrieveHostLockoutInfo" }, "task": true }, { "name": "restRessubscrHostTrackedSubscriberRetrieveHostTrackedSubscribers", "summary": "retrieveHostTrackedSubscribers", "description": "Method to retrieve Host Tracked Subscribers. Intention : RETRIEVER retrieveHostTrackedSubscribers: class-level retriever API retrieveHostTrackedSubscribers of class ressubscr.HostTrackedSubscriber", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"hostTrkPlcyName\": \"string\", \"siteId\": \"string\", \"timeOut\": 123}", "required": false, "schema": { "type": "object", "required": [ "hostTrkPlcyName", "objectClassName", "siteId", "timeOut" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "hostTrkPlcyName": { "type": "string" }, "siteId": { "type": "string" }, "timeOut": { "type": "integer" } }, "description": "Model containing the method level model for struct HostTrackedSubscrRtrvStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrHostTrackedSubscriberRetrieveHostTrackedSubscribers" }, "task": true }, { "name": "restRessubscrIPoESessionRequestClearIpoeSessions", "summary": "requestClearIpoeSessions", "description": "Request clearing the IPOE Session with the specified parameters. The clearIpoeSessionConfig siteId and svcId parameters are required. If using any other optional clearIpoeSessionConfig parameters, one of sapId or interfaceId must be set. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"svcId\": 123, \"sapId\": \"string\", \"interfaceName\": \"string\", \"macAddress\": \"string\", \"circuitId\": \"string\", \"remoteId\": \"string\", \"interDestId\": \"string\", \"ipAddress\": \"string\", \"portName\": \"string\", \"subscriberName\": \"string\", \"sapSessionId\": 123}", "required": false, "schema": { "type": "object", "required": [ "circuitId", "interDestId", "interfaceName", "ipAddress", "macAddress", "objectClassName", "portName", "remoteId", "sapId", "sapSessionId", "siteId", "subscriberName", "svcId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "svcId": { "type": "integer" }, "sapId": { "type": "string" }, "interfaceName": { "type": "string" }, "macAddress": { "type": "string" }, "circuitId": { "type": "string" }, "remoteId": { "type": "string" }, "interDestId": { "type": "string" }, "ipAddress": { "type": "string" }, "portName": { "type": "string" }, "subscriberName": { "type": "string" }, "sapSessionId": { "type": "integer" } }, "description": "Model containing the method level model for struct ClearIpoeSessionStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrIPoESessionRequestClearIpoeSessions" }, "task": true }, { "name": "restRessubscrIPoESessionRetrieveIPoESessions", "summary": "retrieveIPoESessions", "description": "Method used to query the NE for the IPoE session(s) for. Intention : RETRIEVER retrieveIPoESessions: class-level retriever API retrieveIPoESessions of class ressubscr.IPoESession", "input": [ { "name": "body", "type": "object", "info": ": {\"aInCircuitId\": \"string\", \"aInRemoteId\": \"string\", \"retrievingIpoeSessionStruct\": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"svcId\": 123, \"sapId\": \"string\", \"innerEncap\": 123, \"outerEncap\": 123, \"sessionsMac\": \"string\", \"sessionsId\": 123, \"timeout\": 123}, \"retrieveQoSOvr\": \"boolean\", \"retrieveManagedRoutes\": \"boolean\", \"retrieveBgpPeerInfo\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "retrieveBgpPeerInfo", "retrieveManagedRoutes", "retrieveQoSOvr", "retrievingIpoeSessionStruct" ], "properties": { "aInCircuitId": { "type": "string" }, "aInRemoteId": { "type": "string" }, "retrievingIpoeSessionStruct": { "type": "object", "required": [ "innerEncap", "objectClassName", "outerEncap", "sapId", "sessionsId", "sessionsMac", "siteId", "svcId", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "svcId": { "type": "integer" }, "sapId": { "type": "string" }, "innerEncap": { "type": "integer" }, "outerEncap": { "type": "integer" }, "sessionsMac": { "type": "string" }, "sessionsId": { "type": "integer" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct RetrievingIpoeSessionStruct. to decode json data to internal NFM-P object model" }, "retrieveQoSOvr": { "type": "boolean", "description": " Specifies if QoS Override should be retrieved,the default is \"true\".The QoS Override won't be retrieved if Service preferences \"retrieveQoSOvr\" is false. default:true", "default": false }, "retrieveManagedRoutes": { "type": "boolean", "description": " Specifies if Managed Routes should be retrieved,the default is \"true\".The Managed Routes won't be retrieved if Service preferences \"retrieveManagedRoutes\" isfalse. default:true", "default": false }, "retrieveBgpPeerInfo": { "type": "boolean", "description": " Specifies if BGP Peer Info should be retrieved,the default is \"true\".The Managed Routes won't be retrieved if Service preferences \"retrieveManagedRoutes\" isfalse. default:true", "default": false } }, "description": "Model containing the method level model for IPoESession.retrieveIPoESessions to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrIPoESessionRetrieveIPoESessions" }, "task": true }, { "name": "restRessubscrIPoESessionRadiusClassAttributeRetrieveIPoESessionRadiusClasses", "summary": "retrieveIPoESessionRadiusClasses", "description": "Method used to query the NE for the IPoE Session RADIUS Class Attributes related to the specified IPoE Session. Intention : RETRIEVER retrieveIPoESessionRadiusClasses: class-level retriever API retrieveIPoESessionRadiusClasses of class ressubscr.IPoESessionRadiusClassAttribute", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"sessionIndex\": 123, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "sessionIndex", "siteId", "timeout" ], "properties": { "siteId": { "type": "string", "description": " Site ID for the IPoE Session." }, "sessionIndex": { "type": "integer", "description": " IPoE Session ID." }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait before receiving the results.This is an optional input parameter. The default value is 5 minutes (300000). default:300000" } }, "description": "Model containing the method level model for IPoESessionRadiusClassAttribute.retrieveIPoESessionRadiusClasses to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrIPoESessionRadiusClassAttributeRetrieveIPoESessionRadiusClasses" }, "task": true }, { "name": "restRessubscrManagedSubscriberHostRetrieveManagedSubscriberHosts", "summary": "retrieveManagedSubscriberHosts", "description": "Intention : RETRIEVER retrieveManagedSubscriberHosts: class-level retriever API retrieveManagedSubscriberHosts of class ressubscr.ManagedSubscriberHost", "input": [ { "name": "body", "type": "object", "info": ": {\"retrieveManagedSubscriberHostsStruct\": {\"objectClassName\": \"string\", \"hostType\": \"string\", \"siteId\": \"string\", \"svcId\": 123, \"ipAddress\": \"string\", \"macAddress\": \"string\"}, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "retrieveManagedSubscriberHostsStruct", "timeout" ], "properties": { "retrieveManagedSubscriberHostsStruct": { "type": "object", "required": [ "hostType", "ipAddress", "macAddress", "objectClassName", "siteId", "svcId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "hostType": { "type": "string" }, "siteId": { "type": "string" }, "svcId": { "type": "integer" }, "ipAddress": { "type": "string" }, "macAddress": { "type": "string" } }, "description": "Model containing the method level model for struct RetrieveManagedSubscriberHostsStruct. to decode json data to internal NFM-P object model" }, "timeout": { "type": "integer", "description": " (Optional) The number of milliseconds to wait beforereceiving the results. If the results are notreceived in the given time, the method returns. default:0" } }, "description": "Model containing the method level model for ManagedSubscriberHost.retrieveManagedSubscriberHosts to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrManagedSubscriberHostRetrieveManagedSubscriberHosts" }, "task": true }, { "name": "restRessubscrResidentialSubscriberModifySubscriberIdent", "summary": "rest_ressubscr_ResidentialSubscriber_modifySubscriberIdent", "description": "rest_ressubscr_ResidentialSubscriber_modifySubscriberIdent", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrResidentialSubscriberModifySubscriberIdent" }, "task": true }, { "name": "restRessubscrResidentialSubscriberInstanceClearSubscriberHostDhcp6LeaseState", "summary": "clearSubscriberHostDhcp6LeaseState", "description": "Request clearing the Dynamic DHCPv6 lease state for the specified IPv6 address and optional prefix length. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER clearSubscriberHostDhcp6LeaseState: class-level [functionality clearing] (modifier) API clearSubscriberHos...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"serviceId\": 123, \"subscrIdent\": \"string\", \"ipv6Address\": \"string\", \"ipv6AddressPrefixLength\": 123}", "required": false, "schema": { "type": "object", "required": [ "ipv6Address", "ipv6AddressPrefixLength", "objectClassName", "serviceId", "siteId", "subscrIdent" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "serviceId": { "type": "integer" }, "subscrIdent": { "type": "string" }, "ipv6Address": { "type": "string" }, "ipv6AddressPrefixLength": { "type": "integer" } }, "description": "Model containing the method level model for struct ClearDhcp6LeaseStateConfiguration. to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrResidentialSubscriberInstanceClearSubscriberHostDhcp6LeaseState" }, "task": true }, { "name": "restRessubscrResidentialSubscriberInstanceClearSubscriberHostLeaseState", "summary": "clearSubscriberHostLeaseState", "description": "Request clearing the Dynamic DHCP lease state for the specified IP address. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER clearSubscriberHostLeaseState: instance-level [functionality clearing] (modifier) API clearSubscriberHostLeaseState of class ressubscr.R...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"ipAddress\": \"string\", \"serviceId\": 123, \"siteId\": \"string\", \"subscrIdent\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "ipAddress", "objectClassName", "serviceId", "siteId", "subscrIdent" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "ipAddress": { "type": "string" }, "serviceId": { "type": "integer" }, "siteId": { "type": "string" }, "subscrIdent": { "type": "string" } }, "description": "Model containing the method level model for struct ClearDhcpLeaseStateConfiguration. to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrResidentialSubscriberInstanceClearSubscriberHostLeaseState" }, "task": true }, { "name": "restRessubscrResidentialSubscriberInstanceRequestClearHostIgmpHostTracking", "summary": "requestClearHostIgmpHostTracking", "description": "Request clearing of the IGMP Host Tracking information for a specific host of the Subscriber instance. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearHostIgmpHostTracking: instance-level modifier API requestClearHostIgmpHostTracking of class ressu...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInOnlyStats\": \"boolean\", \"clearHostStruct\": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"ipAddress\": \"string\", \"sapId\": \"string\", \"subscrIdent\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "clearHostStruct" ], "properties": { "aInOnlyStats": { "type": "boolean", "default": false }, "clearHostStruct": { "type": "object", "required": [ "ipAddress", "objectClassName", "sapId", "siteId", "subscrIdent" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "ipAddress": { "type": "string" }, "sapId": { "type": "string" }, "subscrIdent": { "type": "string" } }, "description": "Model containing the method level model for struct ClearHostStruct. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for ResidentialSubscriberInstance.requestClearHostIgmpHostTracking to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrResidentialSubscriberInstanceRequestClearHostIgmpHostTracking" }, "task": true }, { "name": "restRessubscrResidentialSubscriberInstanceRequestClearIgmpHostTracking", "summary": "requestClearIgmpHostTracking", "description": "Request clearing of all IGMP Host Tracking information for this Subscriber instance. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearIgmpHostTracking: instance-level modifier API requestClearIgmpHostTracking of class ressubscr.ResidentialSubscriber...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restRessubscrResidentialSubscriberInstanceRequestClearIgmpHostTracking" }, "task": true }, { "name": "restRessubscrResidentialSubscriberInstanceRetrieveL2tpTunnels", "summary": "retrieveL2tpTunnels", "description": "Method used to retrieve L2TP tunnel endpoint information on LNS from LAC. Intention : RETRIEVER retrieveL2tpTunnels: class-level retriever API retrieveL2tpTunnels of class ressubscr.ResidentialSubscriberInstance", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"subscriberId\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "objectClassName", "siteId", "subscriberId", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "subscriberId": { "type": "string" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct L2TPTunnelRetrievalStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrResidentialSubscriberInstanceRetrieveL2tpTunnels" }, "task": true }, { "name": "restRessubscrResidentialSubscriberInstanceRetrieveResidentialSubscriber", "summary": "retrieveResidentialSubscriber", "description": "Method used to retrieve Residential Subscriber Instance information from the network Intention : RETRIEVER retrieveResidentialSubscriber: class-level retriever API retrieveResidentialSubscriber of class ressubscr.ResidentialSubscriberInstance", "input": [ { "name": "body", "type": "object", "info": ": {\"subscrIdent\": \"string\", \"siteId\": \"string\", \"timeout\": 123, \"shallowRetrieval\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "shallowRetrieval", "siteId", "subscrIdent", "timeout" ], "properties": { "subscrIdent": { "type": "string", "description": " Unique identification of subscriber instance." }, "siteId": { "type": "string", "description": " The site ID of the NE to query." }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait before receiving the results. If no results arereceived in the given time, the method returns. default:0" }, "shallowRetrieval": { "type": "boolean", "description": " If it is true, not all of the properties are retrieved for quick responseThis is an optional input parameter. The default value is false. default:false", "default": false } }, "description": "Model containing the method level model for ResidentialSubscriberInstance.retrieveResidentialSubscriber to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrResidentialSubscriberInstanceRetrieveResidentialSubscriber" }, "task": true }, { "name": "restRessubscrResidentialSubscriberInstanceRetrieveSubscriberVirtualSubnets", "summary": "retrieveSubscriberVirtualSubnets", "description": "Method to retrieve Subscribe rVirtual Subnets. Intention : RETRIEVER retrieveSubscriberVirtualSubnets: class-level retriever API retrieveSubscriberVirtualSubnets of class ressubscr.ResidentialSubscriberInstance", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"serviceId\": 123, \"subscrIdent\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "objectClassName", "serviceId", "siteId", "subscrIdent", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "serviceId": { "type": "integer" }, "subscrIdent": { "type": "string" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct RetrievingVirtualSubnetStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrResidentialSubscriberInstanceRetrieveSubscriberVirtualSubnets" }, "task": true }, { "name": "restRessubscrResidentialSubscriberManagerClearDynamicHost", "summary": "clearDynamicHost", "description": "Request clearing the Dynamic DHCP lease state for the specified IP address. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER clearDynamicHost: instance-level [functionality clearing] (modifier) API clearDynamicHost on default instance res-subscr-mgr of class res...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"ipAddress\": \"string\", \"sapId\": \"string\", \"subscrIdent\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "ipAddress", "objectClassName", "sapId", "siteId", "subscrIdent" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "ipAddress": { "type": "string" }, "sapId": { "type": "string" }, "subscrIdent": { "type": "string" } }, "description": "Model containing the method level model for struct ClearHostStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrResidentialSubscriberManagerClearDynamicHost" }, "task": true }, { "name": "restRessubscrResidentialSubscriberManagerClearSap", "summary": "clearSap", "description": "Request clearing all Dynamic DHCP(DHCP + IPoE DHCP6) lease state for the specified SAP. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER clearSap: instance-level [functionality clearing] (modifier) API clearSap on default instance res-subscr-mgr of class ressubs...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"hostType\": \"string\", \"sapId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "hostType", "objectClassName", "sapId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "hostType": { "type": "string" }, "sapId": { "type": "string" } }, "description": "Model containing the method level model for struct ClearSapStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrResidentialSubscriberManagerClearSap" }, "task": true }, { "name": "restRessubscrResidentialSubscriberManagerCreateSubSvcComponents", "summary": "createSubSvcComponents", "description": "Creates (clones or overrides) the \"service component\" - Subscriber profile, SLA profile(s) and the (scheduler and QoS) policies these profiles or a SAP (in the assigned model) are using. Generally, this method will create new objects IFF the ossAssignedName specified in the corresponding templates parameter is not assigned to any of the existing profile policy objects. Intention : MODIFIER createSubSvcComponents: class-level [administrative creation] (modifier) API createSubSvcComponents on...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"neSystemAddress\": \"string\", \"vlanPerSub\": \"boolean\", \"esm\": \"boolean\", \"templates\": \"object\", \"downstreamLineRate\": 123, \"upstreamLineRate\": 123, \"ingressAcls\": \"object\", \"egressAcls\": \"object\", \"allRates\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "allRates", "downstreamLineRate", "egressAcls", "esm", "ingressAcls", "neSystemAddress", "templates", "upstreamLineRate", "vlanPerSub" ], "properties": { "neSystemAddress": { "type": "string", "description": " System address of the NE to deploy the profileor policy to (i.e. where the sub resides).NFM-P may detect that a requested profile policyalready exists in NFM-P but hasn't been deployed tothis node yet; then NFM-P will deploy it." }, "vlanPerSub": { "type": "boolean", "description": " true for SAP (VLAN) per subscriberfalse for SAP (VLAN) per service (any flavor)", "default": false }, "esm": { "type": "boolean", "description": " false if subscriber uses assigned SAPs;true otherwise (enhanced subscriber managementa.k.a. ESM)", "default": false }, "templates": { "type": "object", "description": " Map of the NFM-P profiles or QoS policies FDNs toclone.The values: structures containing two strings:1) \"ossAssignedName\" - the name OSS assigned tothis profile or policy.2) \"fdn\" - the FDN of the template SLA profile (forESM) or QoS scheduler policy to replicate (forassigned SAPs).The keys follow the naming convention:* For ESM:Application|\"subscriber\"Where:o Application can be one of (unchecked):\"all\"|\"hsi\"|voip\"|\"video\"\"\"all\" is used for VLAN per subscribermodel, other values - for VLAN perservice modelso \"subscriber\" represents the subscriberprofile* For assigned SAP model:Direction-Application-PolicyTypeWhere:o Direction:\"ingress\"|\"egress\"o Application - the same values as in theESM case above - i.e.\"all\"|\"hsi\"|voip\"|\"video\"o PolicyType:\"qos\"|\"scheduler\"Examples of the keys in the map:- \"subscriber\" - ESM, VLAN per subscriber,subscriber profile, at most 1 entry- \"all\" - ESM, VLAN per subscriber, SLAprofile, at most 1 entry- \"hsi\" - ESM, VLAN per service, SLA profile- \"ingress-all-qos\" - assigned SAP, VLAN persubscriber, QoS policy- \"egress-hsi-scheduler\" - assigned SAP,VLAN per service, scheduler policyAn invocation should have the following entries:- for ESM, VLAN per subscriber:\"subscriber\", \"all\"- for ESM, VLAN per service:\"subscriber\", \"all\",\"hsi\",voip\",\"video\"- for assigned SAPs, VLAN per subscriber:\"egress-all-qos\"\"egress-all-scheduler\"\"ingress-all-qos\"\"ingress-all-scheduler\"- for assigned SAPs, VLAN per service:\"egress-hsi-qos\"\"egress-hsi-scheduler\"\"ingress-hsi-qos\"\"ingress-hsi-scheduler\"\"egress-video-qos\"\"egress-video-scheduler\"\"ingress-video-qos\"\"ingress-video-scheduler\"\"egress-voip-qos\"\"egress-voip-scheduler\"\"ingress-voip-qos\"\"ingress-voip-scheduler\"", "additionalProperties": { "type": "object", "required": [ "fdn", "objectClassName", "ossAssignedDescription", "ossAssignedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "ossAssignedName": { "type": "string" }, "ossAssignedDescription": { "type": "string" }, "fdn": { "type": "string" } }, "description": "Model containing the method level model for struct TemplateIdPair. to decode json data to internal NFM-P object model" } }, "downstreamLineRate": { "type": "integer", "description": " Subscriber downstream DSL line rate" }, "upstreamLineRate": { "type": "integer", "description": " Subscriber upstream DSL line rate" }, "ingressAcls": { "type": "object", "description": " Map of ingress ACL FDNs to use in the clone.Keys are the applications:- for VLAN per service models:\"hsi\"|voip\"|\"video\" (unchecked)- for VLAN per subscriber model:\"all\" (1 and only 1 entry).DEFAULT blank (null)", "additionalProperties": { "type": "string" } }, "egressAcls": { "type": "object", "description": " Map of ingress ACL FDNs to use in the clone.Keys are the applications:- for VLAN per service models:\"hsi\"|voip\"|\"video\" (unchecked)- for VLAN per subscriber model:\"all\" (1 and only 1 entry).DEFAULT blank (null)", "additionalProperties": { "type": "string" } }, "allRates": { "type": "object", "description": " Map of all rates to configure in the profiles (QoS scheduler) policies being createdEntries are named using the following convention:Direction-ForwardingClass-CirOrPir-Application-svcNumberwhere:Direction:\"ingress\"|\"egress\"ForwardingClass:\"be\"|\"l2\"|\"af\"|\"l1\"|\"h2\"|\"ef\"|\"h1\"|\"nc\"CirOrPir:\"cir\"|\"pir\" - CIR cannot be specified without corresponding PIR rate configuration.Both CIR and PIR may be specified as \"-1\" meaning \"MAX\"Application (unchecked):\"hsi\"|voip\"|\"video\"svcNumber:1..n (unique integer per application instance)Example:\"ingress-ef-pir-video-1\"", "additionalProperties": { "type": "integer" } } }, "description": "Model containing the method level model for ResidentialSubscriberManager.createSubSvcComponents to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrResidentialSubscriberManagerCreateSubSvcComponents" }, "task": true }, { "name": "restRessubscrResidentialSubscriberManagerCreateSubSvcComponentsDyn", "summary": "createSubSvcComponentsDyn", "description": "Intention : MODIFIER createSubSvcComponentsDyn: class-level [administrative creation] (modifier) API createSubSvcComponentsDyn on default instance res-subscr-mgr of class ressubscr.ResidentialSubscriberManager The map of FDNs of (top-level) objects created when executing this request. The keys are the OSS assigned names passed in the parameters \"templates\", ingress egressAclNames, and ingress egressIpv6AclNames. The values are the FDNs of NFM-P global profiles policies created for this req...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"serviceCompSelectionId\": \"string\", \"neSystemAddress\": \"string\", \"vlanPerSub\": \"boolean\", \"esm\": \"boolean\", \"templates\": \"object\", \"services\": [{\"objectClassName\": \"string\", \"name\": \"string\", \"application\": \"string\", \"params\": \"object\"}], \"downstreamLineRate\": 123, \"upstreamLineRate\": 123, \"ingressAclNames\": \"object\", \"egressAclNames\": \"object\", \"ingressIpv6AclNames\": \"object\", \"egressIpv6AclNames\": \"object\", \"allRates\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "allRates", "downstreamLineRate", "egressAclNames", "egressIpv6AclNames", "esm", "ingressAclNames", "ingressIpv6AclNames", "neSystemAddress", "objectClassName", "serviceCompSelectionId", "services", "templates", "upstreamLineRate", "vlanPerSub" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "serviceCompSelectionId": { "type": "string" }, "neSystemAddress": { "type": "string" }, "vlanPerSub": { "type": "boolean", "default": false }, "esm": { "type": "boolean", "default": false }, "templates": { "type": "object", "additionalProperties": { "type": "object", "required": [ "fdn", "objectClassName", "ossAssignedDescription", "ossAssignedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "ossAssignedName": { "type": "string" }, "ossAssignedDescription": { "type": "string" }, "fdn": { "type": "string" } }, "description": "Model containing the method level model for struct TemplateIdPair. to decode json data to internal NFM-P object model" } }, "services": { "type": "array", "items": { "type": "object", "required": [ "application", "name", "objectClassName", "params" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "name": { "type": "string" }, "application": { "type": "string" }, "params": { "type": "object", "additionalProperties": { "type": "string" } } }, "description": "Model containing the method level model for struct ServiceSelectionInfo. to decode json data to internal NFM-P object model" } }, "downstreamLineRate": { "type": "integer" }, "upstreamLineRate": { "type": "integer" }, "ingressAclNames": { "type": "object", "additionalProperties": { "type": "object", "required": [ "fdn", "objectClassName", "ossAssignedDescription", "ossAssignedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "ossAssignedName": { "type": "string" }, "ossAssignedDescription": { "type": "string" }, "fdn": { "type": "string" } }, "description": "Model containing the method level model for struct TemplateIdPair. to decode json data to internal NFM-P object model" } }, "egressAclNames": { "type": "object", "additionalProperties": { "type": "object", "required": [ "fdn", "objectClassName", "ossAssignedDescription", "ossAssignedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "ossAssignedName": { "type": "string" }, "ossAssignedDescription": { "type": "string" }, "fdn": { "type": "string" } }, "description": "Model containing the method level model for struct TemplateIdPair. to decode json data to internal NFM-P object model" } }, "ingressIpv6AclNames": { "type": "object", "additionalProperties": { "type": "object", "required": [ "fdn", "objectClassName", "ossAssignedDescription", "ossAssignedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "ossAssignedName": { "type": "string" }, "ossAssignedDescription": { "type": "string" }, "fdn": { "type": "string" } }, "description": "Model containing the method level model for struct TemplateIdPair. to decode json data to internal NFM-P object model" } }, "egressIpv6AclNames": { "type": "object", "additionalProperties": { "type": "object", "required": [ "fdn", "objectClassName", "ossAssignedDescription", "ossAssignedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "ossAssignedName": { "type": "string" }, "ossAssignedDescription": { "type": "string" }, "fdn": { "type": "string" } }, "description": "Model containing the method level model for struct TemplateIdPair. to decode json data to internal NFM-P object model" } }, "allRates": { "type": "object", "additionalProperties": { "type": "integer" } } }, "description": "Model containing the method level model for struct ServiceComponentsCreateConfiguration. to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrResidentialSubscriberManagerCreateSubSvcComponentsDyn" }, "task": true }, { "name": "restRessubscrResidentialSubscriberManagerDeleteSubSvcComponents", "summary": "deleteSubSvcComponents", "description": "Deletes the \"service components\" - subscriber profile, SLA profile(s), scheduler and QoS policies created both explicitly and implicitly when executing method createSubSvcComponents(). Intention : MODIFIER deleteSubSvcComponents: class-level [administrative deletion] (modifier) API deleteSubSvcComponents on default instance res-subscr-mgr of class ressubscr.ResidentialSubscriberManager Success or failure. Fails if a profile policy is still used by some subscriber host SAP and hence can't be...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"neSystemAddress\": \"string\", \"fdns\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "fdns", "neSystemAddress" ], "properties": { "neSystemAddress": { "type": "string", "description": " System address of the NE to remove the profileor policy from (i.e. where the sub resides).The value \"0.0.0.0\" requests the removal of theprofiles policies from ALL nodes in the network(i.e. globally)." }, "fdns": { "type": "array", "description": " FDNs of the profiles policies to be deleted.", "items": { "type": "string" } } }, "description": "Model containing the method level model for ResidentialSubscriberManager.deleteSubSvcComponents to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrResidentialSubscriberManagerDeleteSubSvcComponents" }, "task": true }, { "name": "restRessubscrResidentialSubscriberManagerRetrieveResidentialSubscribers", "summary": "retrieveResidentialSubscribers", "description": "Method used to retrieve extended Residential Subscriber information from the network. It can include also the information for the children classes as it is requested by invoker. Intention : RETRIEVER retrieveResidentialSubscribers: class-level retriever API retrieveResidentialSubscribers on default instance res-subscr-mgr of class ressubscr.ResidentialSubscriberManager Residential Subscriber Instance info object where only persisted information about Residential Subscriber Instance is set. ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"timeout\": 123, \"subscriberRetrievalInfoList\": [{\"objectClassName\": \"string\", \"siteId\": \"string\", \"subscriberIdentification\": \"string\", \"includeChildren\": \"boolean\"}], \"retrieveQoSOvr\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "retrieveQoSOvr", "subscriberRetrievalInfoList", "timeout" ], "properties": { "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If the results arenot received in the given time, the method returns." }, "subscriberRetrievalInfoList": { "type": "array", "description": " ", "items": { "type": "object", "required": [ "includeChildren", "objectClassName", "siteId", "subscriberIdentification" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "subscriberIdentification": { "type": "string" }, "includeChildren": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for struct ResidentialSubscriberRetrievalStruct. to decode json data to internal NFM-P object model" } }, "retrieveQoSOvr": { "type": "boolean", "description": " Specifies if QoS Override should be retrieved,the default is \"true\".The QoS Override won't be retrieved if Service preferences \"retrieveQoSOvr\" is false. default:true", "default": false } }, "description": "Model containing the method level model for ResidentialSubscriberManager.retrieveResidentialSubscribers to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrResidentialSubscriberManagerRetrieveResidentialSubscribers" }, "task": true }, { "name": "restRessubscrResidentialSubscriberManagerTriggerCollect", "summary": "rest_ressubscr_ResidentialSubscriberManager_triggerCollect", "description": "rest_ressubscr_ResidentialSubscriberManager_triggerCollect", "input": [ { "name": "body", "type": "object", "info": ": {\"instanceNames\": \"array\", \"currentDataClasses\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "currentDataClasses", "instanceNames" ], "properties": { "instanceNames": { "type": "array", "description": " The object instances (FDNs) to collect statistics on.", "uniqueItems": true, "items": { "type": "string" } }, "currentDataClasses": { "type": "array", "description": " The statistics 'current data' classes to collect for.", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for ResidentialSubscriberManager.triggerCollect to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrResidentialSubscriberManagerTriggerCollect" }, "task": true }, { "name": "restRessubscrResidentialSubscriberManagerUpdateSubSvcComponentsDynAcl", "summary": "updateSubSvcComponentsDynAcl", "description": "Revise ACL objects that were created using Velocity Template Typically, the method would be invoked after a Velocity Template modification Intention : MODIFIER updateSubSvcComponentsDynAcl: class-level modifier API updateSubSvcComponentsDynAcl on default instance res-subscr-mgr of class ressubscr.ResidentialSubscriberManager List of FDNs affected by Template modification", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restRessubscrResidentialSubscriberManagerUpdateSubSvcComponentsDynAcl" }, "task": true }, { "name": "restRessubscrSlaProfileInstanceRetrieveSlaProfileInstances", "summary": "retrieveSlaProfileInstances", "description": "Method used to query the NE for SLA Profile Instance(s) which have RADIUS overrides. SLA Profile Instances without overrides will not be retrieved Intention : RETRIEVER retrieveSlaProfileInstances: class-level retriever API retrieveSlaProfileInstances of class ressubscr.SlaProfileInstance", "input": [ { "name": "body", "type": "object", "info": ": {\"retrievingSlaProfileInstStruct\": {\"objectClassName\": \"string\", \"spiGroupType\": \"string\", \"siteId\": \"string\", \"subscrIdent\": \"string\", \"portName\": \"string\", \"innerEncap\": 123, \"outerEncap\": 123, \"slaProfileName\": \"string\", \"spiGroupId\": 123, \"timeout\": 123}, \"retrieveQoSOvr\": \"boolean\", \"retrieveAcclpEncap\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "retrieveAcclpEncap", "retrieveQoSOvr", "retrievingSlaProfileInstStruct" ], "properties": { "retrievingSlaProfileInstStruct": { "type": "object", "required": [ "innerEncap", "objectClassName", "outerEncap", "portName", "siteId", "slaProfileName", "spiGroupId", "spiGroupType", "subscrIdent", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "spiGroupType": { "type": "string" }, "siteId": { "type": "string" }, "subscrIdent": { "type": "string" }, "portName": { "type": "string" }, "innerEncap": { "type": "integer" }, "outerEncap": { "type": "integer" }, "slaProfileName": { "type": "string" }, "spiGroupId": { "type": "integer" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct RetrievingSlaProfileInstStruct. to decode json data to internal NFM-P object model" }, "retrieveQoSOvr": { "type": "boolean", "description": " Specifies if QoS Override should be retrieved,the default is \"true\".The QoS Override won't be retrieved if Service preferences \"retrieveQoSOvr\" is false. default:true", "default": false }, "retrieveAcclpEncap": { "type": "boolean", "description": " Specifies if Access Loop Encapsulation should be retrieved,the default is \"true\".The Access Loop Encapsulation won't be retrieved if Service preferences \"retrieveAcclpEncap\" is false. default:true", "default": false } }, "description": "Model containing the method level model for SlaProfileInstance.retrieveSlaProfileInstances to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrSlaProfileInstanceRetrieveSlaProfileInstances" }, "task": true }, { "name": "restRessubscrSubBrgAddressPoolRetrieveAddrPools", "summary": "retrieveAddrPools", "description": "Method used to retrieve Subscriber IP Address pools of a BRG. Intention : RETRIEVER retrieveAddrPools: class-level retriever API retrieveAddrPools of class ressubscr.SubBrgAddressPool List of bindings.", "input": [ { "name": "body", "type": "object", "info": ": {\"aInBrgId\": \"string\", \"aInPoolName\": \"string\", \"aInSiteId\": \"string\", \"aInTimeout\": 123, \"retrieveIpAddrs\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "retrieveIpAddrs" ], "properties": { "aInBrgId": { "type": "string" }, "aInPoolName": { "type": "string" }, "aInSiteId": { "type": "string" }, "aInTimeout": { "type": "integer" }, "retrieveIpAddrs": { "type": "boolean", "description": " Specifies to retrieve Standby IP addresses of the pool or not. Default is FALSE.This is optional parameter. default:false", "default": false } }, "description": "Model containing the method level model for SubBrgAddressPool.retrieveAddrPools to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrSubBrgAddressPoolRetrieveAddrPools" }, "task": true }, { "name": "restRessubscrSubSlaacHostRadiusClassAttributeRetrieveSubSlaacHostRadiusClasses", "summary": "retrieveSubSlaacHostRadiusClasses", "description": "Method used to query the NE for the Residential Subscriber SLAAC Host RADIUS Class Attributes related to the specified Residential Subscriber SLAAC Host. Intention : RETRIEVER retrieveSubSlaacHostRadiusClasses: class-level retriever API retrieveSubSlaacHostRadiusClasses of class ressubscr.SubSlaacHostRadiusClassAttribute", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"serviceId\": 123, \"ipAddressType\": 123, \"ipAddress\": \"string\", \"macAddress\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "ipAddress", "ipAddressType", "macAddress", "serviceId", "siteId", "timeout" ], "properties": { "siteId": { "type": "string", "description": " Site ID for the Residential Subscriber SLAAC Host." }, "serviceId": { "type": "integer", "description": " Service ID for the Residential Subscriber SLAAC Host." }, "ipAddressType": { "type": "integer", "description": " The IP address type of the Residential Subscriber SLAAC Host, 1 for IPv4 or 2 for IPv6.This is an optional input parameter. If not specified, address type is inferredfrom IP address input parameter. default:0" }, "ipAddress": { "type": "string", "description": " The IP address of the Residential Subscriber SLAAC Host." }, "macAddress": { "type": "string", "description": " The MAC address of the Residential Subscriber SLAAC Host." }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait before receiving the results.This is an optional input parameter. The default value is 5 minutes (300000). default:300000" } }, "description": "Model containing the method level model for SubSlaacHostRadiusClassAttribute.retrieveSubSlaacHostRadiusClasses to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrSubSlaacHostRadiusClassAttributeRetrieveSubSlaacHostRadiusClasses" }, "task": true }, { "name": "restRessubscrSubscrMacErrorRetrieveSubMacError", "summary": "retrieveSubMacError", "description": "Method used to retrieve information about the error associated with the MAC detected by the subscriber from NE. Intention : RETRIEVER retrieveSubMacError: class-level retriever API retrieveSubMacError of class ressubscr.SubscrMacError", "input": [ { "name": "body", "type": "object", "info": ": {\"aInReportedTimeMinutes\": 123, \"aInReportedTimeSeconds\": 123, \"aInReportedTimeHours\": 123, \"aInReportedTimeDay\": 123, \"aInReportedTimeMonth\": 123, \"aInReportedTimeYear\": 123, \"aInMacIndex\": 123, \"aInSiteId\": \"string\", \"aInMacAddress\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInReportedTimeMinutes": { "type": "integer" }, "aInReportedTimeSeconds": { "type": "integer" }, "aInReportedTimeHours": { "type": "integer" }, "aInReportedTimeDay": { "type": "integer" }, "aInReportedTimeMonth": { "type": "integer" }, "aInReportedTimeYear": { "type": "integer" }, "aInMacIndex": { "type": "integer" }, "aInSiteId": { "type": "string" }, "aInMacAddress": { "type": "string" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait before receiving the results.The method returns if no results are received in the given time.This is an optional input parameter. The default value is 5 minutes (300000). default:300000" } }, "description": "Model containing the method level model for SubscrMacError.retrieveSubMacError to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrSubscrMacErrorRetrieveSubMacError" }, "task": true }, { "name": "restRessubscrSubscrSapErrorRetrieveSubSapError", "summary": "retrieveSubSapError", "description": "Method used to retrieve information about the error associated with the SAP detected by the subscriber from NE. Intention : RETRIEVER retrieveSubSapError: class-level retriever API retrieveSubSapError of class ressubscr.SubscrSapError", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSapPortId\": 123, \"aInReportedTimeMinutes\": 123, \"aInReportedTimeSeconds\": 123, \"aInReportedTimeHours\": 123, \"aInReportedTimeDay\": 123, \"aInReportedTimeMonth\": 123, \"aInReportedTimeYear\": 123, \"aInSapIndex\": 123, \"aInSiteId\": \"string\", \"aInInnerEncapValue\": 123, \"aInOuterEncapValue\": 123, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInSapPortId": { "type": "integer" }, "aInReportedTimeMinutes": { "type": "integer" }, "aInReportedTimeSeconds": { "type": "integer" }, "aInReportedTimeHours": { "type": "integer" }, "aInReportedTimeDay": { "type": "integer" }, "aInReportedTimeMonth": { "type": "integer" }, "aInReportedTimeYear": { "type": "integer" }, "aInSapIndex": { "type": "integer" }, "aInSiteId": { "type": "string" }, "aInInnerEncapValue": { "type": "integer" }, "aInOuterEncapValue": { "type": "integer" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait before receiving the results.The method returns if no results are received in the given time.This is an optional input parameter. The default value is 5 minutes (300000). default:300000" } }, "description": "Model containing the method level model for SubscrSapError.retrieveSubSapError to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrSubscrSapErrorRetrieveSubSapError" }, "task": true }, { "name": "restRessubscrSubscrSdpErrorRetrieveSubSdpError", "summary": "retrieveSubSdpError", "description": "Method used to retrieve information about the errors associated with the SDP Bind detected by the subscriber from NE. Intention : RETRIEVER retrieveSubSdpError: class-level retriever API retrieveSubSdpError of class ressubscr.SubscrSdpError", "input": [ { "name": "body", "type": "object", "info": ": {\"aInReportedTimeMinutes\": 123, \"aInReportedTimeSeconds\": 123, \"aInReportedTimeHours\": 123, \"aInSdpId\": 123, \"aInReportedTimeDay\": 123, \"aInReportedTimeMonth\": 123, \"aInReportedTimeYear\": 123, \"aInSdpBndIndex\": 123, \"aInSiteId\": \"string\", \"aInVcId\": 123, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInReportedTimeMinutes": { "type": "integer" }, "aInReportedTimeSeconds": { "type": "integer" }, "aInReportedTimeHours": { "type": "integer" }, "aInSdpId": { "type": "integer" }, "aInReportedTimeDay": { "type": "integer" }, "aInReportedTimeMonth": { "type": "integer" }, "aInReportedTimeYear": { "type": "integer" }, "aInSdpBndIndex": { "type": "integer" }, "aInSiteId": { "type": "string" }, "aInVcId": { "type": "integer" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait before receiving the results.The method returns if no results are received in the given time.This is an optional input parameter. The default value is 5 minutes (300000). default:300000" } }, "description": "Model containing the method level model for SubscrSdpError.retrieveSubSdpError to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrSubscrSdpErrorRetrieveSubSdpError" }, "task": true }, { "name": "restRessubscrSubscrUnknownErrorRetrieveSubUnknownError", "summary": "retrieveSubUnknownError", "description": "Method used to retrieve information about the error for which system could not determine the originating SAP or SDP binding from NE. Intention : RETRIEVER retrieveSubUnknownError: class-level retriever API retrieveSubUnknownError of class ressubscr.SubscrUnknownError", "input": [ { "name": "body", "type": "object", "info": ": {\"aInReportedTimeMinutes\": 123, \"aInReportedTimeSeconds\": 123, \"aInReportedTimeHours\": 123, \"aInIndex\": 123, \"aInReportedTimeDay\": 123, \"aInReportedTimeMonth\": 123, \"aInReportedTimeYear\": 123, \"aInSiteId\": \"string\", \"aInMacAddress\": \"string\", \"aInServiceId\": 123, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInReportedTimeMinutes": { "type": "integer" }, "aInReportedTimeSeconds": { "type": "integer" }, "aInReportedTimeHours": { "type": "integer" }, "aInIndex": { "type": "integer" }, "aInReportedTimeDay": { "type": "integer" }, "aInReportedTimeMonth": { "type": "integer" }, "aInReportedTimeYear": { "type": "integer" }, "aInSiteId": { "type": "string" }, "aInMacAddress": { "type": "string" }, "aInServiceId": { "type": "integer" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait before receiving the results.The method returns if no results are received in the given time.This is an optional input parameter. The default value is 5 minutes (300000). default:300000" } }, "description": "Model containing the method level model for SubscrUnknownError.retrieveSubUnknownError to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrSubscrUnknownErrorRetrieveSubUnknownError" }, "task": true }, { "name": "restRessubscrSubscriberHostFindSlaProfileStringSuggestions", "summary": "findSlaProfileStringSuggestions", "description": "Method used to retrieve a L2TP session from NE. Intention : RETRIEVER findSlaProfileStringSuggestions: class-level [object finder] (retriever) API findSlaProfileStringSuggestions of class ressubscr.SubscriberHost", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrSubscriberHostFindSlaProfileStringSuggestions" }, "task": true }, { "name": "restRessubscrSubscriberHostRetrieveL2TPSession", "summary": "retrieveL2TPSession", "description": "Method used to retrieve a L2TP session from NE. Intention : RETRIEVER retrieveL2TPSession: class-level retriever API retrieveL2TPSession of class ressubscr.SubscriberHost", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"pppSessionIndex\": 123, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "objectClassName", "pppSessionIndex", "siteId", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "pppSessionIndex": { "type": "integer" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct L2TPSessionRetrievalStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrSubscriberHostRetrieveL2TPSession" }, "task": true }, { "name": "restRessubscrSubscriberHostRetrieveSAPHosts", "summary": "retrieveSAPHosts", "description": "Method used to query the NE for the currently active subscriber hosts for a specified SAP. Additionally, the L2 Aware Host information will be returned in the output when GTP Local Breakout is \"true\" for the host and when the MAC Address and IP Address are specified in the request. Intention : RETRIEVER retrieveSAPHosts: class-level retriever API retrieveSAPHosts of class ressubscr.SubscriberHost List of the subscriber hosts retrieved from the node(CommonManagedEntityInformation).", "input": [ { "name": "body", "type": "object", "info": ": {\"aInCrdtCtrlOperValues\": \"boolean\", \"aInEncapValue\": 123, \"aInHostIpAddr\": \"string\", \"aInHostMacAddr\": \"string\", \"aInSiteId\": \"string\", \"aInServiceId\": 123, \"aInPortId\": 123, \"additionalStateInfo\": \"boolean\", \"timeout\": 123, \"retrieveQoSOvr\": \"boolean\", \"retrieveSlaacAddr\": \"boolean\", \"retrieveBgpPeerInfo\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "additionalStateInfo", "retrieveBgpPeerInfo", "retrieveQoSOvr", "retrieveSlaacAddr", "timeout" ], "properties": { "aInCrdtCtrlOperValues": { "type": "boolean", "default": false }, "aInEncapValue": { "type": "integer" }, "aInHostIpAddr": { "type": "string" }, "aInHostMacAddr": { "type": "string" }, "aInSiteId": { "type": "string" }, "aInServiceId": { "type": "integer" }, "aInPortId": { "type": "integer" }, "additionalStateInfo": { "type": "boolean", "description": " Specifies if retrieval of connectivity info and lease stateis also desired.", "default": false }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns." }, "retrieveQoSOvr": { "type": "boolean", "description": " Specifies if Sub SLAAC QoS Override should be retrieved,the default is \"true\".It won't be retrieved if ESM System preferences \"retrieveQoSOvr\" is false. default:true", "default": false }, "retrieveSlaacAddr": { "type": "boolean", "description": " Specifies if retrieval of subscriber SLAAC host addresses is also desired.This is an optional input parameter. The default value is true.The SLAAC Host Address retrieval will be performed only on \"retrieveSlaacAddr\" is true for the method and\"retrieveSlaacHostAddr\" is true for the ResidentialSubscriberManager. default:true", "default": false }, "retrieveBgpPeerInfo": { "type": "boolean", "description": " Specifies if Sub SLAAC BGP Peer Info should be retrieved,the default is \"true\".It won't be retrieved if ESM System preferences \"retrieveBgpPeerInfo\" is false. default:true", "default": false } }, "description": "Model containing the method level model for SubscriberHost.retrieveSAPHosts to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrSubscriberHostRetrieveSAPHosts" }, "task": true }, { "name": "restRessubscrSubscriberHostRetrieveSubscriberHosts", "summary": "retrieveSubscriberHosts", "description": "Method used to query the NE for the currently active subscriber hosts for a specified subscriber. Intention : RETRIEVER retrieveSubscriberHosts: class-level retriever API retrieveSubscriberHosts of class ressubscr.SubscriberHost List of Subscriber Hosts (CommonManagedEntityInformation) that were retrieved from the node.", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSubscrId\": \"string\", \"aInAdditionalStateInfo\": \"boolean\", \"aInCrdtCtrlOperValues\": \"boolean\", \"aInSiteId\": \"string\", \"timeout\": 123, \"retrieveQoSOvr\": \"boolean\", \"retrieveSlaacAddr\": \"boolean\", \"retrieveBgpPeerInfo\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "retrieveBgpPeerInfo", "retrieveQoSOvr", "retrieveSlaacAddr", "timeout" ], "properties": { "aInSubscrId": { "type": "string" }, "aInAdditionalStateInfo": { "type": "boolean", "default": false }, "aInCrdtCtrlOperValues": { "type": "boolean", "default": false }, "aInSiteId": { "type": "string" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns." }, "retrieveQoSOvr": { "type": "boolean", "description": " Specifies if Sub SLAAC QoS Override should be retrieved,the default is \"true\".It won't be retrieved if ESM System preferences \"retrieveQoSOvr\" is false. default:true", "default": false }, "retrieveSlaacAddr": { "type": "boolean", "description": " Specifies if retrieval of subscriber SLAAC host addresses is also desired.This is an optional input parameter. The default value is true.The SLAAC Host Address retrieval will be performed only on \"retrieveSlaacAddr\" is true for the method and\"retrieveSlaacHostAddr\" is true for the ResidentialSubscriberManager. default:true", "default": false }, "retrieveBgpPeerInfo": { "type": "boolean", "description": " Specifies if Sub SLAAC BGP Peer Info should be retrieved,the default is \"true\".It won't be retrieved if ESM System preferences \"retrieveBgpPeerInfo\" is false. default:true", "default": false } }, "description": "Model containing the method level model for SubscriberHost.retrieveSubscriberHosts to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrSubscriberHostRetrieveSubscriberHosts" }, "task": true }, { "name": "restRessubscrSubscriberHostConfigurationEvalLeaseStatePerSap", "summary": "evalLeaseStatePerSap", "description": "Intention : MODIFIER evalLeaseStatePerSap: class-level modifier API evalLeaseStatePerSap of class ressubscr.SubscriberHostConfiguration DescendantInfo: arp.ArpHost DescendantInfo: ressubscr.SubscriberHost Resulting objects list.", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"encapType\": \"string\", \"siteId\": \"string\", \"svcId\": 123, \"portId\": 123, \"innerEncapVal\": 123, \"outerEncapVal\": 123, \"combinedEncap\": 123}", "required": false, "schema": { "type": "object", "required": [ "combinedEncap", "encapType", "innerEncapVal", "objectClassName", "outerEncapVal", "portId", "siteId", "svcId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "encapType": { "type": "string" }, "siteId": { "type": "string" }, "svcId": { "type": "integer" }, "portId": { "type": "integer" }, "innerEncapVal": { "type": "integer" }, "outerEncapVal": { "type": "integer" }, "combinedEncap": { "type": "integer" } }, "description": "Model containing the method level model for struct EvalLeaseStatePerSapStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrSubscriberHostConfigurationEvalLeaseStatePerSap" }, "task": true }, { "name": "restRessubscrSubscriberHostConfigurationEvalLeaseStatePerSapId", "summary": "evalLeaseStatePerSapId", "description": "Intention : MODIFIER evalLeaseStatePerSapId: class-level modifier API evalLeaseStatePerSapId of class ressubscr.SubscriberHostConfiguration DescendantInfo: arp.ArpHost DescendantInfo: ressubscr.SubscriberHost Resulting objects list.", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restRessubscrSubscriberHostConfigurationEvalLeaseStatePerSapId" }, "task": true }, { "name": "restRessubscrSubscriberHostConfigurationUpdateMultipleSubscrHosts", "summary": "updateMultipleSubscrHosts", "description": "Method used to force to change properties of the SubscriberHost. These properties are: subscriber profile, sla profile and application profile. Method is also used to force re-evaluation of lease state. Either change of subscriber profile, sla profile, application profile or re-evaluation of lease state can be requested at one time. This method can be used when serviceId is not known for a SubscriberHost, but subscrIdent, siteId and ipAddress must be known. Intention : RETRIEVER updateMultipl...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"configs\": [{\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\"}], \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "configs", "timeout" ], "properties": { "configs": { "type": "array", "description": " List of configuration objects with desired values to configure thesubscriber hosts.The configuration objects must also have the subscrIdent, siteId,ipAddressType and ipAddress been set in the config list.The macAddress value should be specified with hyphens as separators between the octets, for example, 00-80-21-AB-CD-EF.For non-pppoe hosts, pppoeSessionId should be set to 0. If you are not using a second site, pleasedo not use the secondSiteId property.If the method is being used to configure multiple hosts then each host must have a separate block withinressubscr.SubscriberHostConfiguration tags.", "items": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns." } }, "description": "Model containing the method level model for SubscriberHostConfiguration.updateMultipleSubscrHosts to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrSubscriberHostConfigurationUpdateMultipleSubscrHosts" }, "task": true }, { "name": "restRessubscrSubscriberHostCreditResetResetCredit", "summary": "rest_ressubscr_SubscriberHostCreditReset_resetCredit", "description": "rest_ressubscr_SubscriberHostCreditReset_resetCredit", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restRessubscrSubscriberHostCreditResetResetCredit" }, "task": true }, { "name": "restRessubscrSubscriberHostForceRenewForceRenewSubscriberHost", "summary": "rest_ressubscr_SubscriberHostForceRenew_forceRenewSubscriberHost", "description": "rest_ressubscr_SubscriberHostForceRenew_forceRenewSubscriberHost", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restRessubscrSubscriberHostForceRenewForceRenewSubscriberHost" }, "task": true }, { "name": "restRessubscrSubscriberPccRuleEntryRetrievePccRule", "summary": "retrievePccRule", "description": "Method used to query the NE for the PCC Rules Intention : RETRIEVER retrievePccRule: class-level retriever API retrievePccRule of class ressubscr.SubscriberPccRuleEntry", "input": [ { "name": "body", "type": "object", "info": ": {\"retrievePccRuleStruct\": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"subPccRuleName\": \"string\", \"subPccRuleKey\": 123, \"subPCCRuleFlowId\": 123}, \"retrievePccRuleFlowEntry\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "retrievePccRuleFlowEntry", "retrievePccRuleStruct" ], "properties": { "retrievePccRuleStruct": { "type": "object", "required": [ "objectClassName", "siteId", "subPCCRuleFlowId", "subPccRuleKey", "subPccRuleName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "subPccRuleName": { "type": "string", "description": " default: yes:" }, "subPccRuleKey": { "type": "integer", "description": " default: yes:0" }, "subPCCRuleFlowId": { "type": "integer", "description": " default: yes:0" } }, "description": "Model containing the method level model for struct RetrievePccRuleStruct. to decode json data to internal NFM-P object model" }, "retrievePccRuleFlowEntry": { "type": "boolean", "description": " Specifies if Flow Entries should be retrieved,the default is \"true\". default:true", "default": false } }, "description": "Model containing the method level model for SubscriberPccRuleEntry.retrievePccRule to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrSubscriberPccRuleEntryRetrievePccRule" }, "task": true }, { "name": "restRessubscrSubscriberPccRuleEntryRetrievePccRulesPerSubscrHost", "summary": "retrievePccRulesPerSubscrHost", "description": "Method used to query all PCC Rules used by a particular subscriber host present in the given NE. Intention : RETRIEVER retrievePccRulesPerSubscrHost: class-level retriever API retrievePccRulesPerSubscrHost of class ressubscr.SubscriberPccRuleEntry", "input": [ { "name": "body", "type": "object", "info": ": {\"subHostPccRuleInfoStruct\": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"serviceId\": 123, \"sapPortId\": 123, \"sapEncapValue\": 123, \"ipAddress\": \"string\", \"macAddress\": \"string\", \"pppSessionIndex\": 123}, \"includeFlowsInRtrv\": \"boolean\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "includeFlowsInRtrv", "subHostPccRuleInfoStruct", "timeout" ], "properties": { "subHostPccRuleInfoStruct": { "type": "object", "required": [ "ipAddress", "macAddress", "objectClassName", "pppSessionIndex", "sapEncapValue", "sapPortId", "serviceId", "siteId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "serviceId": { "type": "integer" }, "sapPortId": { "type": "integer" }, "sapEncapValue": { "type": "integer" }, "ipAddress": { "type": "string" }, "macAddress": { "type": "string" }, "pppSessionIndex": { "type": "integer" } }, "description": "Model containing the method level model for struct SubHostPccRuleStruct. to decode json data to internal NFM-P object model" }, "includeFlowsInRtrv": { "type": "boolean", "description": " default:true", "default": false }, "timeout": { "type": "integer", "description": " default:0" } }, "description": "Model containing the method level model for SubscriberPccRuleEntry.retrievePccRulesPerSubscrHost to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrSubscriberPccRuleEntryRetrievePccRulesPerSubscrHost" }, "task": true }, { "name": "restRessubscrSubscriberQosOverrideRetrieveSubscriberQosOverrides", "summary": "retrieveSubscriberQosOverrides", "description": "Method to retrieve Subscriber QoS Overrides. Intention : RETRIEVER retrieveSubscriberQosOverrides: class-level retriever API retrieveSubscriberQosOverrides of class ressubscr.SubscriberQosOverride", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"subIdent\": \"string\", \"siteId\": \"string\", \"timeOut\": 123}", "required": false, "schema": { "type": "object", "required": [ "objectClassName", "siteId", "subIdent", "timeOut" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "subIdent": { "type": "string" }, "siteId": { "type": "string" }, "timeOut": { "type": "integer" } }, "description": "Model containing the method level model for struct SubscriberQosOverrideRtrvStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrSubscriberQosOverrideRetrieveSubscriberQosOverrides" }, "task": true }, { "name": "restRessubscrSubscriberServiceRetrieveSubSvc", "summary": "retrieveSubSvc", "description": "Method used to Subscriber Services from NE. Intention : RETRIEVER retrieveSubSvc: class-level retriever API retrieveSubSvc of class ressubscr.SubscriberService List of Subsciber Services (CommonManagedEntityInformation)that were retrieved from the node.", "input": [ { "name": "body", "type": "object", "info": ": {\"aInEncapValue\": 123, \"aInAddrType\": \"string\", \"aInAddress\": \"string\", \"aInPppoeSessionId\": 123, \"aInSiteId\": \"string\", \"aInServiceId\": 123, \"aInMacAddr\": \"string\", \"aInPortId\": 123, \"aInSubId\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInEncapValue": { "type": "integer" }, "aInAddrType": { "type": "string" }, "aInAddress": { "type": "string" }, "aInPppoeSessionId": { "type": "integer" }, "aInSiteId": { "type": "string" }, "aInServiceId": { "type": "integer" }, "aInMacAddr": { "type": "string" }, "aInPortId": { "type": "integer" }, "aInSubId": { "type": "string" } }, "description": "Model containing the method level model for SubscriberService.retrieveSubSvc to decode json data to internal NFM-P object model" } } ], "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": "/restRessubscrSubscriberServiceRetrieveSubSvc" }, "task": true }, { "name": "restRipAuthenticationKeyRemoveAuthenticationKey", "summary": "rest_rip_AuthenticationKey_removeAuthenticationKey", "description": "rest_rip_AuthenticationKey_removeAuthenticationKey", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restRipAuthenticationKeyRemoveAuthenticationKey" }, "task": true }, { "name": "restRipInterfaceConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class rip.Interface This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restRipInterfaceConfigure" }, "task": true }, { "name": "restRipSiteConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class rip.Site This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restRipSiteConfigure" }, "task": true }, { "name": "restRmdAccessInterfaceInitiateDiscovery", "summary": "rest_rmd_AccessInterface_initiateDiscovery", "description": "rest_rmd_AccessInterface_initiateDiscovery", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restRmdAccessInterfaceInitiateDiscovery" }, "task": true }, { "name": "restRmdDeviceReset", "summary": "rest_rmd_Device_reset", "description": "rest_rmd_Device_reset", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restRmdDeviceReset" }, "task": true }, { "name": "restRmdDiscoveredDeviceCreateDevice", "summary": "createDevice", "description": "This method will create remote managed devices. Intention : MODIFIER createDevice: class-level [administrative creation] (modifier) API createDevice of class rmd.DiscoveredDevice", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restRmdDiscoveredDeviceCreateDevice" }, "task": true }, { "name": "restRmdDiscoveredDeviceResync", "summary": "rest_rmd_DiscoveredDevice_resync", "description": "rest_rmd_DiscoveredDevice_resync", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restRmdDiscoveredDeviceResync" }, "task": true }, { "name": "restRmdRmdConfigDiscoverDevices", "summary": "discoverDevices", "description": "This method will discover remote managed devices. Intention : MODIFIER discoverDevices: class-level modifier API discoverDevices of class rmd.RmdConfig", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restRmdRmdConfigDiscoverDevices" }, "task": true }, { "name": "restRmdRmdConfigStartDiscovery", "summary": "rest_rmd_RmdConfig_startDiscovery", "description": "rest_rmd_RmdConfig_startDiscovery", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restRmdRmdConfigStartDiscovery" }, "task": true }, { "name": "restRollbackRollbackNEInfoConfigRedundancyRlbkSync", "summary": "rest_rollback_RollbackNEInfo_configRedundancyRlbkSync", "description": "rest_rollback_RollbackNEInfo_configRedundancyRlbkSync", "input": [ { "name": "body", "type": "object", "info": ": {\"neId\": \"string\", \"configSyncType\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "configSyncType", "neId" ], "properties": { "neId": { "type": "string", "description": " " }, "configSyncType": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for RollbackNEInfo.configRedundancyRlbkSync to decode json data to internal NFM-P object model" } } ], "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": "/restRollbackRollbackNEInfoConfigRedundancyRlbkSync" }, "task": true }, { "name": "restRollbackRollbackNEInfoCreateRollbckCheckPt", "summary": "rest_rollback_RollbackNEInfo_createRollbckCheckPt", "description": "rest_rollback_RollbackNEInfo_createRollbckCheckPt", "input": [ { "name": "body", "type": "object", "info": ": {\"neId\": \"string\", \"checkPtComment\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "checkPtComment", "neId" ], "properties": { "neId": { "type": "string", "description": " " }, "checkPtComment": { "type": "string", "description": " " } }, "description": "Model containing the method level model for RollbackNEInfo.createRollbckCheckPt to decode json data to internal NFM-P object model" } } ], "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": "/restRollbackRollbackNEInfoCreateRollbckCheckPt" }, "task": true }, { "name": "restRollbackRollbackNEInfoCreateRollbckRescue", "summary": "rest_rollback_RollbackNEInfo_createRollbckRescue", "description": "rest_rollback_RollbackNEInfo_createRollbckRescue", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restRollbackRollbackNEInfoCreateRollbckRescue" }, "task": true }, { "name": "restRollbackRollbackNEInfoDeleteRollbckCheckPt", "summary": "rest_rollback_RollbackNEInfo_deleteRollbckCheckPt", "description": "rest_rollback_RollbackNEInfo_deleteRollbckCheckPt", "input": [ { "name": "body", "type": "object", "info": ": {\"neId\": \"string\", \"rollbackIndex\": 123}", "required": false, "schema": { "type": "object", "required": [ "neId", "rollbackIndex" ], "properties": { "neId": { "type": "string", "description": " " }, "rollbackIndex": { "type": "integer", "description": " " } }, "description": "Model containing the method level model for RollbackNEInfo.deleteRollbckCheckPt to decode json data to internal NFM-P object model" } } ], "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": "/restRollbackRollbackNEInfoDeleteRollbckCheckPt" }, "task": true }, { "name": "restRollbackRollbackNEInfoDeleteRollbckRescue", "summary": "rest_rollback_RollbackNEInfo_deleteRollbckRescue", "description": "rest_rollback_RollbackNEInfo_deleteRollbckRescue", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restRollbackRollbackNEInfoDeleteRollbckRescue" }, "task": true }, { "name": "restRollbackRollbackNEInfoExecuteCompareCheckpoint", "summary": "executeCompareCheckpoint", "description": "Intention : RETRIEVER executeCompareCheckpoint: class-level retriever API executeCompareCheckpoint of class rollback.RollbackNEInfo", "input": [ { "name": "body", "type": "object", "info": ": {\"isSynchronized\": \"boolean\", \"clientId\": \"string\", \"neId\": \"string\", \"cliCommand\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "cliCommand", "clientId", "isSynchronized", "neId" ], "properties": { "isSynchronized": { "type": "boolean", "description": " ", "default": false }, "clientId": { "type": "string", "description": " " }, "neId": { "type": "string", "description": " " }, "cliCommand": { "type": "string", "description": " " } }, "description": "Model containing the method level model for RollbackNEInfo.executeCompareCheckpoint to decode json data to internal NFM-P object model" } } ], "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": "/restRollbackRollbackNEInfoExecuteCompareCheckpoint" }, "task": true }, { "name": "restRollbackRollbackNEInfoExecuteViewCheckPoint", "summary": "executeViewCheckPoint", "description": "Intention : RETRIEVER executeViewCheckPoint: class-level retriever API executeViewCheckPoint of class rollback.RollbackNEInfo The result of the executed command (returned as a string).", "input": [ { "name": "body", "type": "object", "info": ": {\"isSynchronized\": \"boolean\", \"clientId\": \"string\", \"neId\": \"string\", \"rollbackIndex\": 123}", "required": false, "schema": { "type": "object", "required": [ "clientId", "isSynchronized", "neId", "rollbackIndex" ], "properties": { "isSynchronized": { "type": "boolean", "description": " Wait until executed command finished. True to wait, false otherwise.", "default": false }, "clientId": { "type": "string", "description": " Identifies the client Id that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "neId": { "type": "string", "description": " " }, "rollbackIndex": { "type": "integer", "description": " " } }, "description": "Model containing the method level model for RollbackNEInfo.executeViewCheckPoint to decode json data to internal NFM-P object model" } } ], "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": "/restRollbackRollbackNEInfoExecuteViewCheckPoint" }, "task": true }, { "name": "restRollbackRollbackNEInfoRedundancyRollbackSync", "summary": "rest_rollback_RollbackNEInfo_redundancyRollbackSync", "description": "rest_rollback_RollbackNEInfo_redundancyRollbackSync", "input": [ { "name": "body", "type": "object", "info": ": {\"neId\": \"string\", \"syncType\": 123}", "required": false, "schema": { "type": "object", "required": [ "neId", "syncType" ], "properties": { "neId": { "type": "string", "description": " " }, "syncType": { "type": "integer", "description": " " } }, "description": "Model containing the method level model for RollbackNEInfo.redundancyRollbackSync to decode json data to internal NFM-P object model" } } ], "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": "/restRollbackRollbackNEInfoRedundancyRollbackSync" }, "task": true }, { "name": "restRollbackRollbackNEInfoRevertRollbckCheckPt", "summary": "rest_rollback_RollbackNEInfo_revertRollbckCheckPt", "description": "rest_rollback_RollbackNEInfo_revertRollbckCheckPt", "input": [ { "name": "body", "type": "object", "info": ": {\"neId\": \"string\", \"rollbackIndex\": 123}", "required": false, "schema": { "type": "object", "required": [ "neId", "rollbackIndex" ], "properties": { "neId": { "type": "string", "description": " " }, "rollbackIndex": { "type": "integer", "description": " " } }, "description": "Model containing the method level model for RollbackNEInfo.revertRollbckCheckPt to decode json data to internal NFM-P object model" } } ], "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": "/restRollbackRollbackNEInfoRevertRollbckCheckPt" }, "task": true }, { "name": "restRollbackRollbackNEInfoRevertRollbckRescue", "summary": "rest_rollback_RollbackNEInfo_revertRollbckRescue", "description": "rest_rollback_RollbackNEInfo_revertRollbckRescue", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restRollbackRollbackNEInfoRevertRollbckRescue" }, "task": true }, { "name": "restRpAbstractAdminGroupPolicyFindAdminGroups", "summary": "findAdminGroups", "description": "Intention : RETRIEVER findAdminGroups: class-level [object finder] (retriever) API findAdminGroups of class rp.AbstractAdminGroupPolicy DescendantInfo: rp.AdminGroupPolicy", "input": [ { "name": "body", "type": "object", "info": ": {\"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"siteId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filter", "siteId" ], "properties": { "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "siteId": { "type": "string", "description": " " } }, "description": "Model containing the method level model for AdminGroupPolicy.findAdminGroups to decode json data to internal NFM-P object model" } } ], "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": "/restRpAbstractAdminGroupPolicyFindAdminGroups" }, "task": true }, { "name": "restRpAbstractAdminGroupPolicyFindInterfaces", "summary": "findInterfaces", "description": "Intention : RETRIEVER findInterfaces: instance-level [object finder] (retriever) API findInterfaces of class rp.AbstractAdminGroupPolicy DescendantInfo: rp.AdminGroupPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restRpAbstractAdminGroupPolicyFindInterfaces" }, "task": true }, { "name": "restRpAbstractAdminGroupPolicyFindLspPaths", "summary": "findLspPaths", "description": "Intention : RETRIEVER findLspPaths: instance-level [object finder] (retriever) API findLspPaths of class rp.AbstractAdminGroupPolicy DescendantInfo: rp.AdminGroupPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restRpAbstractAdminGroupPolicyFindLspPaths" }, "task": true }, { "name": "restRpAbstractAdminGroupPolicyFindLsps", "summary": "findLsps", "description": "Intention : RETRIEVER findLsps: instance-level [object finder] (retriever) API findLsps of class rp.AbstractAdminGroupPolicy DescendantInfo: rp.AdminGroupPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restRpAbstractAdminGroupPolicyFindLsps" }, "task": true }, { "name": "restRpAbstractSrlgGroupPolicyFindInterfaces", "summary": "findInterfaces", "description": "Intention : RETRIEVER findInterfaces: instance-level [object finder] (retriever) API findInterfaces of class rp.AbstractSrlgGroupPolicy DescendantInfo: rp.SrlgGroupPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restRpAbstractSrlgGroupPolicyFindInterfaces" }, "task": true }, { "name": "restRpAdminGroupPolicyFindInterfaces", "summary": "findInterfaces", "description": "Intention : RETRIEVER findInterfaces: instance-level [object finder] (retriever) API findInterfaces of class rp.AdminGroupPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInClassName\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter" ], "properties": { "aInClassName": { "type": "string" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for SharedRiskLinkGroup.findInterfaces to decode json data to internal NFM-P object model" } } ], "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": "/restRpAdminGroupPolicyFindInterfaces" }, "task": true }, { "name": "restRpAdminGroupPolicyFindRouteNextHopPolicyTemplates", "summary": "findRouteNextHopPolicyTemplates", "description": "Intention : RETRIEVER findRouteNextHopPolicyTemplates: instance-level [object finder] (retriever) API findRouteNextHopPolicyTemplates of class rp.AdminGroupPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restRpAdminGroupPolicyFindRouteNextHopPolicyTemplates" }, "task": true }, { "name": "restRpCommunityMemberFindMembers", "summary": "findMembers", "description": "Find the community member instances with the specified type. Intention : RETRIEVER findMembers: class-level [object finder] (retriever) API findMembers of class rp.CommunityMember", "input": [ { "name": "body", "type": "object", "info": ": {\"memberType\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter", "memberType" ], "properties": { "memberType": { "type": "string", "description": " " }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for CommunityMember.findMembers to decode json data to internal NFM-P object model" } } ], "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": "/restRpCommunityMemberFindMembers" }, "task": true }, { "name": "restRpExclusiveEditResetPolicyExclusive", "summary": "rest_rp_ExclusiveEdit_resetPolicyExclusive", "description": "rest_rp_ExclusiveEdit_resetPolicyExclusive", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restRpExclusiveEditResetPolicyExclusive" }, "task": true }, { "name": "restRpExclusiveEditResetPolicyExclusiveForSites", "summary": "rest_rp_ExclusiveEdit_resetPolicyExclusiveForSites", "description": "rest_rp_ExclusiveEdit_resetPolicyExclusiveForSites", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restRpExclusiveEditResetPolicyExclusiveForSites" }, "task": true }, { "name": "restRpFromCriteriaExpandPolicyStatement", "summary": "expandPolicyStatement", "description": "Intention : RETRIEVER expandPolicyStatement: class-level retriever API expandPolicyStatement of class rp.FromCriteria The result of the executed command (returned as a string).", "input": [ { "name": "body", "type": "object", "info": ": {\"neId\": \"string\", \"policyName\": \"string\", \"entryId\": 123}", "required": false, "schema": { "type": "object", "required": [ "entryId", "neId", "policyName" ], "properties": { "neId": { "type": "string", "description": " " }, "policyName": { "type": "string", "description": " " }, "entryId": { "type": "integer", "description": " " } }, "description": "Model containing the method level model for FromCriteria.expandPolicyStatement to decode json data to internal NFM-P object model" } } ], "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": "/restRpFromCriteriaExpandPolicyStatement" }, "task": true }, { "name": "restRpFromCriteriaFindInterfaces", "summary": "findInterfaces", "description": "Intention : RETRIEVER findInterfaces: class-level [object finder] (retriever) API findInterfaces of class rp.FromCriteria", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restRpFromCriteriaFindInterfaces" }, "task": true }, { "name": "restRpPolicyStatementEntryRenum", "summary": "rest_rp_PolicyStatementEntry_renum", "description": "rest_rp_PolicyStatementEntry_renum", "input": [ { "name": "body", "type": "object", "info": ": {\"aInNewEntryFullName\": \"string\", \"aInOldEntryFullName\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInNewEntryFullName": { "type": "string" }, "aInOldEntryFullName": { "type": "string" } }, "description": "Model containing the method level model for SecurityPolicyEntryDefinition.renum to decode json data to internal NFM-P object model" } } ], "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": "/restRpPolicyStatementEntryRenum" }, "task": true }, { "name": "restRpSrlgGroupPolicyFindInterfaces", "summary": "findInterfaces", "description": "Intention : RETRIEVER findInterfaces: instance-level [object finder] (retriever) API findInterfaces of class rp.SrlgGroupPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInClassName\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter" ], "properties": { "aInClassName": { "type": "string" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for SharedRiskLinkGroup.findInterfaces to decode json data to internal NFM-P object model" } } ], "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": "/restRpSrlgGroupPolicyFindInterfaces" }, "task": true }, { "name": "restRsvpForwardingClassMapConfigure", "summary": "rest_rsvp_ForwardingClassMap_configure", "description": "rest_rsvp_ForwardingClassMap_configure", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restRsvpForwardingClassMapConfigure" }, "task": true }, { "name": "restRsvpSessionFindProtectedLsps", "summary": "findProtectedLsps", "description": "Intention : RETRIEVER findProtectedLsps: instance-level [object finder] (retriever) API findProtectedLsps of class rsvp.Session instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restRsvpSessionFindProtectedLsps" }, "task": true }, { "name": "restRsvpSessionFindReroutePath", "summary": "findReroutePath", "description": "Intention : RETRIEVER findReroutePath: instance-level [object finder] (retriever) API findReroutePath of class rsvp.Session instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restRsvpSessionFindReroutePath" }, "task": true }, { "name": "restRsvpTeClassConfigure", "summary": "rest_rsvp_TeClass_configure", "description": "rest_rsvp_TeClass_configure", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restRsvpTeClassConfigure" }, "task": true }, { "name": "restRtrAdminGroupPolicyFindAdminGroups", "summary": "findAdminGroups", "description": "Intention : RETRIEVER findAdminGroups: class-level [object finder] (retriever) API findAdminGroups of class rtr.AdminGroupPolicy", "input": [ { "name": "body", "type": "object", "info": ": {\"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"siteId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filter", "siteId" ], "properties": { "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "siteId": { "type": "string", "description": " " } }, "description": "Model containing the method level model for AdminGroupPolicy.findAdminGroups to decode json data to internal NFM-P object model" } } ], "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": "/restRtrAdminGroupPolicyFindAdminGroups" }, "task": true }, { "name": "restRtrAdminGroupPolicyFindFlexAlgoDefinitions", "summary": "findFlexAlgoDefinitions", "description": "Intention : RETRIEVER findFlexAlgoDefinitions: instance-level [object finder] (retriever) API findFlexAlgoDefinitions of class rtr.AdminGroupPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInClassName\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter" ], "properties": { "aInClassName": { "type": "string" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for AdminGroupPolicy.findFlexAlgoDefinitions to decode json data to internal NFM-P object model" } } ], "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": "/restRtrAdminGroupPolicyFindFlexAlgoDefinitions" }, "task": true }, { "name": "restRtrAdminGroupPolicyFindInterfaces", "summary": "findInterfaces", "description": "Intention : RETRIEVER findInterfaces: instance-level [object finder] (retriever) API findInterfaces of class rtr.AdminGroupPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInClassName\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter" ], "properties": { "aInClassName": { "type": "string" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for SharedRiskLinkGroup.findInterfaces to decode json data to internal NFM-P object model" } } ], "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": "/restRtrAdminGroupPolicyFindInterfaces" }, "task": true }, { "name": "restRtrAdminGroupPolicyFindLspPaths", "summary": "findLspPaths", "description": "Intention : RETRIEVER findLspPaths: instance-level [object finder] (retriever) API findLspPaths of class rtr.AdminGroupPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restRtrAdminGroupPolicyFindLspPaths" }, "task": true }, { "name": "restRtrAdminGroupPolicyFindLsps", "summary": "findLsps", "description": "Intention : RETRIEVER findLsps: instance-level [object finder] (retriever) API findLsps of class rtr.AdminGroupPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restRtrAdminGroupPolicyFindLsps" }, "task": true }, { "name": "restRtrAdminGroupPolicyFindRouteNextHopPolicyTemplates", "summary": "findRouteNextHopPolicyTemplates", "description": "Intention : RETRIEVER findRouteNextHopPolicyTemplates: instance-level [object finder] (retriever) API findRouteNextHopPolicyTemplates of class rtr.AdminGroupPolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restRtrAdminGroupPolicyFindRouteNextHopPolicyTemplates" }, "task": true }, { "name": "restRtrFlexibleAlgorithmDefinitionFindAssociatedObjects", "summary": "findAssociatedObjects", "description": "Intention : RETRIEVER findAssociatedObjects: instance-level [object finder] (retriever) API findAssociatedObjects of class rtr.FlexibleAlgorithmDefinition instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInClassName\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter" ], "properties": { "aInClassName": { "type": "string" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for FlexibleAlgorithmDefinition.findAssociatedObjects to decode json data to internal NFM-P object model" } } ], "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": "/restRtrFlexibleAlgorithmDefinitionFindAssociatedObjects" }, "task": true }, { "name": "restRtrGroupShutDown", "summary": "rest_rtr_Group_shutDown", "description": "rest_rtr_Group_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restRtrGroupShutDown" }, "task": true }, { "name": "restRtrGroupTurnUp", "summary": "rest_rtr_Group_turnUp", "description": "rest_rtr_Group_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restRtrGroupTurnUp" }, "task": true }, { "name": "restRtrIPPacketReassemblySpecificsFindReassemblyPorts", "summary": "findReassemblyPorts", "description": "Find ports which can perform IP Packet Reassembly. Intention : RETRIEVER findReassemblyPorts: instance-level [object finder] (retriever) API findReassemblyPorts of class rtr.IPPacketReassemblySpecifics instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restRtrIPPacketReassemblySpecificsFindReassemblyPorts" }, "task": true }, { "name": "restRtrMultiHomingInterfaceRemoveIpAddress", "summary": "removeIpAddress", "description": "Intention : MODIFIER removeIpAddress: instance-level [administrative deletion] (modifier) API removeIpAddress of class rtr.MultiHomingInterface instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restRtrMultiHomingInterfaceRemoveIpAddress" }, "task": true }, { "name": "restRtrNetworkInterfaceFindGmplsLoopbackInterfaceAddresses", "summary": "findGmplsLoopbackInterfaceAddresses", "description": "Find all addresses configured on a Network Interface of type gmpls-loopback. Intention : RETRIEVER findGmplsLoopbackInterfaceAddresses: class-level [object finder] (retriever) API findGmplsLoopbackInterfaceAddresses of class rtr.NetworkInterface", "input": [ { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "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": "/restRtrNetworkInterfaceFindGmplsLoopbackInterfaceAddresses" }, "task": true }, { "name": "restRtrNetworkInterfaceFindLinkMapProfiles", "summary": "findLinkMapProfiles", "description": "Find LAG Link Mapping Profiles which are associated with this LAG. Intention : RETRIEVER findLinkMapProfiles: class-level [object finder] (retriever) API findLinkMapProfiles of class rtr.NetworkInterface", "input": [ { "name": "portPointer", "type": "string", "info": ": string", "required": false, "schema": { "title": "portPointer", "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": "/restRtrNetworkInterfaceFindLinkMapProfiles" }, "task": true }, { "name": "restRtrNetworkInterfaceFindQueueQroupPolicesAppliedOnPort", "summary": "findQueueQroupPolicesAppliedOnPort", "description": "Intention : RETRIEVER findQueueQroupPolicesAppliedOnPort: class-level [object finder] (retriever) API findQueueQroupPolicesAppliedOnPort of class rtr.NetworkInterface", "input": [ { "name": "portPointer", "type": "string", "info": ": string", "required": false, "schema": { "title": "portPointer", "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": "/restRtrNetworkInterfaceFindQueueQroupPolicesAppliedOnPort" }, "task": true }, { "name": "restRtrNetworkInterfaceRequestPolicyAccountStatsClear", "summary": "requestPolicyAccountStatsClear", "description": "Request clearing of Policy Accounting Statistics on this interface. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestPolicyAccountStatsClear: instance-level modifier API requestPolicyAccountStatsClear of class rtr.NetworkInterface instanceFullName : dis...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInAcctType\": 123, \"aInAcctIndex\": 123, \"aInClearAll\": \"boolean\"}", "required": false, "schema": { "type": "object", "properties": { "aInAcctType": { "type": "integer" }, "aInAcctIndex": { "type": "integer" }, "aInClearAll": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for NetworkInterface.requestPolicyAccountStatsClear to decode json data to internal NFM-P object model" } } ], "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": "/restRtrNetworkInterfaceRequestPolicyAccountStatsClear" }, "task": true }, { "name": "restRtrPeerShutDown", "summary": "rest_rtr_Peer_shutDown", "description": "rest_rtr_Peer_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restRtrPeerShutDown" }, "task": true }, { "name": "restRtrPeerTurnUp", "summary": "rest_rtr_Peer_turnUp", "description": "rest_rtr_Peer_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restRtrPeerTurnUp" }, "task": true }, { "name": "restRtrProtocolSiteShutDown", "summary": "rest_rtr_ProtocolSite_shutDown", "description": "rest_rtr_ProtocolSite_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restRtrProtocolSiteShutDown" }, "task": true }, { "name": "restRtrProtocolSiteTurnUp", "summary": "rest_rtr_ProtocolSite_turnUp", "description": "rest_rtr_ProtocolSite_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restRtrProtocolSiteTurnUp" }, "task": true }, { "name": "restRtrReplicationSegmentPolicyNextHopConfigureReplicationLabels", "summary": "rest_rtr_ReplicationSegmentPolicyNextHop_configureReplicationLabels", "description": "rest_rtr_ReplicationSegmentPolicyNextHop_configureReplicationLabels", "input": [ { "name": "body", "type": "object", "info": ": {\"nextHopInstance\": \"string\", \"labelStringValue\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "labelStringValue", "nextHopInstance" ], "properties": { "nextHopInstance": { "type": "string", "description": " Specifies the Replication Segment Next Hop under which the labels have to be configured." }, "labelStringValue": { "type": "string", "description": " Specifies the labels separated by space. The value provided will replace the entirelabels currently available to the new values.E.G.: 111 222 333" } }, "description": "Model containing the method level model for ReplicationSegmentPolicyNextHop.configureReplicationLabels to decode json data to internal NFM-P object model" } } ], "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": "/restRtrReplicationSegmentPolicyNextHopConfigureReplicationLabels" }, "task": true }, { "name": "restRtrRoutingInstanceSiteConfigureMultipleInstances", "summary": "configureMultipleInstances", "description": "This is used to configure a network interface on multiple routing instances Intention : MODIFIER configureMultipleInstances: class-level [hierarchical administrative configuration/modification] (modifier) API configureMultipleInstances of class rtr.RoutingInstanceSite This API follows hierarchical config model rules. DescendantInfo: rtr.VirtualRouter DescendantInfo: vprn.RoutingInstanceSite", "input": [ { "name": "body", "type": "object", "info": ": {\"routingInstanceSites\": \"array\", \"configInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}}", "required": false, "schema": { "type": "object", "required": [ "configInfo", "routingInstanceSites" ], "properties": { "routingInstanceSites": { "type": "array", "description": " ", "items": { "type": "string" } }, "configInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for RoutingInstanceSite.configureMultipleInstances to decode json data to internal NFM-P object model" } } ], "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": "/restRtrRoutingInstanceSiteConfigureMultipleInstances" }, "task": true }, { "name": "restRtrSharedRiskLinkGroupFindInterfaces", "summary": "findInterfaces", "description": "Intention : RETRIEVER findInterfaces: instance-level [object finder] (retriever) API findInterfaces of class rtr.SharedRiskLinkGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInClassName\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter" ], "properties": { "aInClassName": { "type": "string" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for SharedRiskLinkGroup.findInterfaces to decode json data to internal NFM-P object model" } } ], "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": "/restRtrSharedRiskLinkGroupFindInterfaces" }, "task": true }, { "name": "restRtrStaticArpFind", "summary": "find", "description": "Intention : RETRIEVER find: class-level [object finder] (retriever) API find of class rtr.StaticArp", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restRtrStaticArpFind" }, "task": true }, { "name": "restRtrStaticRouteRetrieveVRFStaticRoutes", "summary": "retrieveVRFStaticRoutes", "description": "FDN of the site. FDN of the service. Static Route Tag. Method used to query the NE for VRF static routes on a particular service. Intention : RETRIEVER retrieveVRFStaticRoutes: class-level retriever API retrieveVRFStaticRoutes of class rtr.StaticRoute", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteFdn\": \"string\", \"aInSvcFdn\": \"string\", \"aInTag\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInSiteFdn": { "type": "string" }, "aInSvcFdn": { "type": "string" }, "aInTag": { "type": "string" } }, "description": "Model containing the method level model for StaticRoute.retrieveVRFStaticRoutes to decode json data to internal NFM-P object model" } } ], "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": "/restRtrStaticRouteRetrieveVRFStaticRoutes" }, "task": true }, { "name": "restRtrVirtualInterfaceConfigureIpAddresses", "summary": "configureIpAddresses", "description": "Intention : MODIFIER configureIpAddresses: instance-level [hierarchical administrative configuration/modification] (modifier) API configureIpAddresses of class rtr.VirtualInterface This API follows hierarchical config model rules. DescendantInfo: vprn.NetworkInterface DescendantInfo: rtr.NetworkInterface instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restRtrVirtualInterfaceConfigureIpAddresses" }, "task": true }, { "name": "restRtrVirtualInterfaceFindByIpAddress", "summary": "findByIpAddress", "description": "Intention : RETRIEVER findByIpAddress: class-level [object finder] (retriever) API findByIpAddress of class rtr.VirtualInterface DescendantInfo: vprn.NetworkInterface DescendantInfo: rtr.NetworkInterface", "input": [ { "name": "body", "type": "object", "info": ": {\"nodeId\": \"string\", \"routingInstance\": 123, \"ipAddress\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "ipAddress", "nodeId", "routingInstance" ], "properties": { "nodeId": { "type": "string", "description": " " }, "routingInstance": { "type": "integer", "description": " " }, "ipAddress": { "type": "string", "description": " " } }, "description": "Model containing the method level model for VirtualInterface.findByIpAddress to decode json data to internal NFM-P object model" } } ], "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": "/restRtrVirtualInterfaceFindByIpAddress" }, "task": true }, { "name": "restRtrVirtualInterfaceFindByIpAddressFilter", "summary": "findByIpAddressFilter", "description": "Intention : RETRIEVER findByIpAddressFilter: class-level [object finder] (retriever) API findByIpAddressFilter of class rtr.VirtualInterface DescendantInfo: vprn.NetworkInterface DescendantInfo: rtr.NetworkInterface", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restRtrVirtualInterfaceFindByIpAddressFilter" }, "task": true }, { "name": "restRtrVirtualInterfaceFindByIpAddressList", "summary": "findByIpAddressList", "description": "Intention : RETRIEVER findByIpAddressList: class-level [object finder] (retriever) API findByIpAddressList of class rtr.VirtualInterface DescendantInfo: vprn.NetworkInterface DescendantInfo: rtr.NetworkInterface", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restRtrVirtualInterfaceFindByIpAddressList" }, "task": true }, { "name": "restRtrVirtualInterfaceFindByName", "summary": "findByName", "description": "Intention : RETRIEVER findByName: class-level [object finder] (retriever) API findByName of class rtr.VirtualInterface DescendantInfo: vprn.NetworkInterface DescendantInfo: rtr.NetworkInterface", "input": [ { "name": "body", "type": "object", "info": ": {\"nodeId\": \"string\", \"routingInstance\": 123, \"interfaceName\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "interfaceName", "nodeId", "routingInstance" ], "properties": { "nodeId": { "type": "string", "description": " " }, "routingInstance": { "type": "integer", "description": " " }, "interfaceName": { "type": "string", "description": " " } }, "description": "Model containing the method level model for VirtualInterface.findByName to decode json data to internal NFM-P object model" } } ], "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": "/restRtrVirtualInterfaceFindByName" }, "task": true }, { "name": "restRtrVirtualInterfaceFindProtocols", "summary": "findProtocols", "description": "Intention : RETRIEVER findProtocols: instance-level [object finder] (retriever) API findProtocols of class rtr.VirtualInterface DescendantInfo: vprn.NetworkInterface DescendantInfo: rtr.NetworkInterface instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restRtrVirtualInterfaceFindProtocols" }, "task": true }, { "name": "restRtrVirtualInterfaceRemoveIpAddress", "summary": "removeIpAddress", "description": "Intention : MODIFIER removeIpAddress: instance-level [administrative deletion] (modifier) API removeIpAddress of class rtr.VirtualInterface DescendantInfo: vprn.NetworkInterface DescendantInfo: rtr.NetworkInterface instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restRtrVirtualInterfaceRemoveIpAddress" }, "task": true }, { "name": "restRtrVirtualInterfaceShutDown", "summary": "shutDown", "description": "Intention : MODIFIER shutDown: instance-level [administrative shut down] (modifier) API shutDown of class rtr.VirtualInterface DescendantInfo: vprn.NetworkInterface DescendantInfo: rtr.NetworkInterface instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restRtrVirtualInterfaceShutDown" }, "task": true }, { "name": "restRtrVirtualInterfaceTurnUp", "summary": "turnUp", "description": "Intention : MODIFIER turnUp: instance-level [administrative turn up] (modifier) API turnUp of class rtr.VirtualInterface DescendantInfo: vprn.NetworkInterface DescendantInfo: rtr.NetworkInterface instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restRtrVirtualInterfaceTurnUp" }, "task": true }, { "name": "restRtrVirtualRouterIpAddressFindSitesFor", "summary": "findSitesFor", "description": "Find the sites used by the IP addresses identified by the filter. Intention : RETRIEVER findSitesFor: class-level [object finder] (retriever) API findSitesFor of class rtr.VirtualRouterIpAddress DescendantInfo: rtr.VirtualRouterSubscriberPrefix", "input": [ { "name": "body", "type": "object", "info": ": {\"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"expandChildren\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "expandChildren", "filter" ], "properties": { "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "expandChildren": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for VirtualRouterIpAddress.findSitesFor to decode json data to internal NFM-P object model" } } ], "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": "/restRtrVirtualRouterIpAddressFindSitesFor" }, "task": true }, { "name": "restSasAbstractTestExecute", "summary": "rest_sas_AbstractTest_execute", "description": "rest_sas_AbstractTest_execute", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSasAbstractTestExecute" }, "task": true }, { "name": "restSasAbstractTestStop", "summary": "rest_sas_AbstractTest_stop", "description": "rest_sas_AbstractTest_stop", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSasAbstractTestStop" }, "task": true }, { "name": "restSasMplsDmSessionRequestClearOamPmDmRawStats", "summary": "requestClearOamPmDmRawStats", "description": "Request clearing of Oam Pm Raw Stats. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearOamPmDmRawStats: instance-level modifier API requestClearOamPmDmRawStats of class sas.MplsDmSession instanceFullName : distinguished/instance name of called obje...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSasMplsDmSessionRequestClearOamPmDmRawStats" }, "task": true }, { "name": "restSasPMSessionTestStopTest", "summary": "rest_sas_PMSessionTest_stopTest", "description": "rest_sas_PMSessionTest_stopTest", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSasPMSessionTestStopTest" }, "task": true }, { "name": "restSasStreamingDelayTemplateFindTests", "summary": "findTests", "description": "Intention : RETRIEVER findTests: instance-level [object finder] (retriever) API findTests of class sas.StreamingDelayTemplate instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restSasStreamingDelayTemplateFindTests" }, "task": true }, { "name": "restSasTWLSessionRequestClearOamPmTwlRawStats", "summary": "requestClearOamPmTwlRawStats", "description": "Request clearing of Oam Pm Raw Stats. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearOamPmTwlRawStats: instance-level modifier API requestClearOamPmTwlRawStats of class sas.TWLSession instanceFullName : distinguished/instance name of called objec...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSasTWLSessionRequestClearOamPmTwlRawStats" }, "task": true }, { "name": "restSasTestAdhocExecuteAndWait", "summary": "adhocExecuteAndWait", "description": "Creates and executes a new STM test. This method waits until the test is complete and all results are retrieved before returning from the network. Intention : MODIFIER adhocExecuteAndWait: class-level modifier API adhocExecuteAndWait of class sas.Test DescendantInfo: vwmsas.PrbsTest DescendantInfo: ethernetoam.AbstractCfmTest DescendantInfo: mpls.LdpTreeTrace DescendantInfo: service.Y1564TestHead DescendantInfo: sas.Trace DescendantInfo: service.MacPurge DescendantInfo: mpls....(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"testedObject\": \"string\", \"test\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"id\": 123, \"displayedName\": \"string\", \"description\": \"string\", \"administrativeState\": 123, \"nePersistent\": \"boolean\", \"neSchedulable\": \"boolean\", \"accountingFiles\": \"boolean\", \"continuousExec\": \"boolean\", \"testResultStorage\": 123, \"probeHistory\": 123, \"publishTopic\": \"boolean\", \"applicationId\": \"string\"}, \"timeout\": 123, \"keepTest\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "keepTest", "test", "testedObject", "timeout" ], "properties": { "testedObject": { "type": "string", "description": " The object under test or system Address of your node." }, "test": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "id": { "type": "integer" }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "administrativeState": { "type": "integer" }, "nePersistent": { "type": "boolean", "default": false }, "neSchedulable": { "type": "boolean", "default": false }, "accountingFiles": { "type": "boolean", "default": false }, "continuousExec": { "type": "boolean", "default": false }, "testResultStorage": { "type": "integer" }, "probeHistory": { "type": "integer" }, "publishTopic": { "type": "boolean", "default": false }, "applicationId": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo TestConfigInfo. to decode json data to internal NFM-P object model" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns." }, "keepTest": { "type": "boolean", "description": " Setting this parameter to false means that anytest created for the purposes of executionwill be deleted after the results are receivedfrom the network.", "default": false } }, "description": "Model containing the method level model for Test.adhocExecuteAndWait to decode json data to internal NFM-P object model" } } ], "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": "/restSasTestAdhocExecuteAndWait" }, "task": true }, { "name": "restSasTestExecuteAndWait", "summary": "executeAndWait", "description": "Immediately starts running an already existing STM test. This method waits until the test is complete and all results are retrieved before returning from the network. Intention : MODIFIER executeAndWait: instance-level modifier API executeAndWait of class sas.Test DescendantInfo: vwmsas.PrbsTest DescendantInfo: ethernetoam.AbstractCfmTest DescendantInfo: mpls.LdpTreeTrace DescendantInfo: service.Y1564TestHead DescendantInfo: sas.Trace DescendantInfo: service.MacPurge Descendant...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restSasTestExecuteAndWait" }, "task": true }, { "name": "restSasTestSetNeSchedulableAdminState", "summary": "rest_sas_Test_setNeSchedulableAdminState", "description": "rest_sas_Test_setNeSchedulableAdminState", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restSasTestSetNeSchedulableAdminState" }, "task": true }, { "name": "restSasTestManagerCfmResourceUsageResync", "summary": "rest_sas_TestManager_CfmResourceUsageResync", "description": "rest_sas_TestManager_CfmResourceUsageResync", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restSasTestManagerCfmResourceUsageResync" }, "task": true }, { "name": "restSasTestManagerCfmVlanDefaultMdResync", "summary": "rest_sas_TestManager_CfmVlanDefaultMdResync", "description": "rest_sas_TestManager_CfmVlanDefaultMdResync", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restSasTestManagerCfmVlanDefaultMdResync" }, "task": true }, { "name": "restSasTestManagerArchiveMultipleTestResults", "summary": "rest_sas_TestManager_archiveMultipleTestResults", "description": "rest_sas_TestManager_archiveMultipleTestResults", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restSasTestManagerArchiveMultipleTestResults" }, "task": true }, { "name": "restSasTestManagerArchiveTest", "summary": "rest_sas_TestManager_archiveTest", "description": "rest_sas_TestManager_archiveTest", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restSasTestManagerArchiveTest" }, "task": true }, { "name": "restSasTestManagerArchiveTestResult", "summary": "rest_sas_TestManager_archiveTestResult", "description": "rest_sas_TestManager_archiveTestResult", "input": [ { "name": "body", "type": "object", "info": ": {\"lTestResultStructObjectId\": 123, \"testFdn\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "testFdn" ], "properties": { "lTestResultStructObjectId": { "type": "integer" }, "testFdn": { "type": "string", "description": " " } }, "description": "Model containing the method level model for TestManager.archiveTestResult to decode json data to internal NFM-P object model" } } ], "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": "/restSasTestManagerArchiveTestResult" }, "task": true }, { "name": "restSasTestManagerDeleteTests", "summary": "rest_sas_TestManager_deleteTests", "description": "rest_sas_TestManager_deleteTests", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restSasTestManagerDeleteTests" }, "task": true }, { "name": "restSasTestManagerExecuteOamTestContext", "summary": "executeOamTestContext", "description": "This method triggers OAM Context Test Generation and Execution. Intention : MODIFIER executeOamTestContext: instance-level modifier API executeOamTestContext on default instance sas of class sas.TestManager", "input": [ { "name": "body", "type": "object", "info": ": {\"contextType\": \"string\", \"testType\": \"string\", \"testedEntities\": \"array\", \"objectList\": \"array\", \"testSuiteName\": \"string\", \"continuous\": \"boolean\", \"schedulePointer\": \"string\", \"parameterList\": \"array\", \"cfmLevel\": 123, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "cfmLevel", "contextType", "continuous", "objectList", "parameterList", "schedulePointer", "testSuiteName", "testType", "testedEntities", "timeout" ], "properties": { "contextType": { "type": "string", "description": " This defines the type of object selected by user for OAM Context test generation." }, "testType": { "type": "string", "description": " The type of test to run on the objects provided in the entity object list." }, "testedEntities": { "type": "array", "description": " List of Entity FDN to be tested in this request, applicability of these object types depend on the testType requested.", "uniqueItems": true, "items": { "type": "string" } }, "objectList": { "type": "array", "description": " List of Object FDNs to test within the Entity, Used for CFM tests to specify specific Sites, SAPs and SdpBindings.for example: List of SAPs inside a VPLS entity, will only test between the specified SAPs.", "uniqueItems": true, "items": { "type": "string" } }, "testSuiteName": { "type": "string", "description": " This defines the Test Suite name to use for this context request. default:" }, "continuous": { "type": "boolean", "description": " This create tests as continuously executed, only applicable to CFM and IcmpPing type tests. default:false", "default": false }, "schedulePointer": { "type": "string", "description": " This provides the FDN of the execution schedule to use on the generated Test Suite. default:" }, "parameterList": { "type": "array", "description": " The parameterList is a list of property and value pairs, in orderfor example: [Test.ATTR_displayedName, \"Test Name\", Test.ATTR_PacketsToSend, \"5\"]generated tests will use the properties in the list set if applicable.", "items": { "type": "string" } }, "cfmLevel": { "type": "integer", "description": " The CFM Maintenance Domain Level the tests will execute on, this is only applicable to CFM test types. Default: 7 default:7" }, "timeout": { "type": "integer", "description": " The length of time to wait for the results to be collected (in minutes). Default: 2 default:2" } }, "description": "Model containing the method level model for TestManager.executeOamTestContext to decode json data to internal NFM-P object model" } } ], "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": "/restSasTestManagerExecuteOamTestContext" }, "task": true }, { "name": "restSasTestManagerExecuteValidator", "summary": "executeValidator", "description": "Starts executing the validator tests for the given tested entities. It can only execute the validator if there is one associated with the tested entity. The return value holds the names of tested entities that could be validated (i.e. there was a validator associated with the tested entity). In other words if the tested entity name is in the input list but not in the output list there is no validator associated with that tested entity. Intention : MODIFIER executeValidator: class-level modif...(description truncated)", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restSasTestManagerExecuteValidator" }, "task": true }, { "name": "restSasTestManagerFindEmptyValidatorTestSuites", "summary": "findEmptyValidatorTestSuites", "description": "The return value holds the names of test suites that do not have any associated tests. In order to succesfully execute a validation (see method 'executeValidator') the tested entity must have exactly one test suite associated which test suite has parameter 'sasValidator' set to true. Intention : RETRIEVER findEmptyValidatorTestSuites: instance-level [object finder] (retriever) API findEmptyValidatorTestSuites on default instance sas of class sas.TestManager", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restSasTestManagerFindEmptyValidatorTestSuites" }, "task": true }, { "name": "restSasTestManagerFindPMSessionsNEs", "summary": "findPMSessionsNEs", "description": "The return value holds the names of Network Elements that have IOM3 cards and support the capabilities cfmDmmSession and cfmSlmSession. These are the nodes that support PMSessions. Intention : RETRIEVER findPMSessionsNEs: class-level [object finder] (retriever) API findPMSessionsNEs on default instance sas of class sas.TestManager", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restSasTestManagerFindPMSessionsNEs" }, "task": true }, { "name": "restSasTestManagerFindPMSessionsVPRNSites", "summary": "findPMSessionsVPRNSites", "description": "The return value holds the names of Network Elements that support TWL sessions and are part of the specified service. Intention : RETRIEVER findPMSessionsVPRNSites: class-level [object finder] (retriever) API findPMSessionsVPRNSites on default instance sas of class sas.TestManager", "input": [ { "name": "body", "type": "object", "info": ": {\"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"serviceId\": 123}", "required": false, "schema": { "type": "object", "required": [ "filter", "serviceId" ], "properties": { "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "serviceId": { "type": "integer", "description": " " } }, "description": "Model containing the method level model for TestManager.findPMSessionsVPRNSites to decode json data to internal NFM-P object model" } } ], "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": "/restSasTestManagerFindPMSessionsVPRNSites" }, "task": true }, { "name": "restSasTestManagerGenerateStmDefaults", "summary": "generateStmDefaults", "description": "Intention : MODIFIER generateStmDefaults: class-level modifier API generateStmDefaults on default instance sas of class sas.TestManager", "input": [ { "name": "body", "type": "object", "info": ": {\"testedEntities\": \"array\", \"testedEntityType\": 123}", "required": false, "schema": { "type": "object", "required": [ "testedEntities", "testedEntityType" ], "properties": { "testedEntities": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "testedEntityType": { "type": "integer", "description": " " } }, "description": "Model containing the method level model for TestManager.generateStmDefaults to decode json data to internal NFM-P object model" } } ], "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": "/restSasTestManagerGenerateStmDefaults" }, "task": true }, { "name": "restSasTestManagerGenerateTeTests", "summary": "rest_sas_TestManager_generateTeTests", "description": "rest_sas_TestManager_generateTeTests", "input": [ { "name": "body", "type": "object", "info": ": {\"testSuites\": \"array\", \"testedEntity\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "testSuites", "testedEntity" ], "properties": { "testSuites": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "testedEntity": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for TestManager.generateTeTests to decode json data to internal NFM-P object model" } } ], "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": "/restSasTestManagerGenerateTeTests" }, "task": true }, { "name": "restSasTestManagerGenerateTests", "summary": "rest_sas_TestManager_generateTests", "description": "rest_sas_TestManager_generateTests", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restSasTestManagerGenerateTests" }, "task": true }, { "name": "restSasTestManagerOneTimeValidate", "summary": "oneTimeValidate", "description": "One Time Validation Intention : MODIFIER oneTimeValidate: instance-level modifier API oneTimeValidate on default instance sas of class sas.TestManager", "input": [ { "name": "body", "type": "object", "info": ": {\"testedEntity\": \"string\", \"testPolicy\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "testPolicy", "testedEntity" ], "properties": { "testedEntity": { "type": "string", "description": " " }, "testPolicy": { "type": "string", "description": " " } }, "description": "Model containing the method level model for TestManager.oneTimeValidate to decode json data to internal NFM-P object model" } } ], "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": "/restSasTestManagerOneTimeValidate" }, "task": true }, { "name": "restSasTestManagerPropagateMepTestOptions", "summary": "rest_sas_TestManager_propagateMepTestOptions", "description": "rest_sas_TestManager_propagateMepTestOptions", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restSasTestManagerPropagateMepTestOptions" }, "task": true }, { "name": "restSasTestManagerResolveTarget", "summary": "resolveTarget", "description": "Intention : RETRIEVER resolveTarget: class-level retriever API resolveTarget on default instance sas of class sas.TestManager", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restSasTestManagerResolveTarget" }, "task": true }, { "name": "restSasTestManagerStopContinuousTests", "summary": "stopContinuousTests", "description": "This method stops one or more continuous tests, or continuous test suites. The return value holds the names of the Continuously executed tests that need to be stopped. 'tests' is a list containing the name of the tests, or testsuites to stop. Only applicable for continuous tests or test suites 'testOrTestsuite' is 1 for test suites, 3 for individual tests. Intention : MODIFIER stopContinuousTests: class-level modifier API stopContinuousTests on default instance sas of class sas.TestManager ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"tests\": \"array\", \"testOrTestsuite\": 123}", "required": false, "schema": { "type": "object", "required": [ "testOrTestsuite", "tests" ], "properties": { "tests": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "testOrTestsuite": { "type": "integer", "description": " " } }, "description": "Model containing the method level model for TestManager.stopContinuousTests to decode json data to internal NFM-P object model" } } ], "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": "/restSasTestManagerStopContinuousTests" }, "task": true }, { "name": "restSasTestManagerStopNeSchedulableTests", "summary": "rest_sas_TestManager_stopNeSchedulableTests", "description": "rest_sas_TestManager_stopNeSchedulableTests", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restSasTestManagerStopNeSchedulableTests" }, "task": true }, { "name": "restSasTestPolicyUpdateAllTestSuites", "summary": "rest_sas_TestPolicy_updateAllTestSuites", "description": "rest_sas_TestPolicy_updateAllTestSuites", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSasTestPolicyUpdateAllTestSuites" }, "task": true }, { "name": "restSasTestSuiteAddTest", "summary": "rest_sas_TestSuite_addTest", "description": "rest_sas_TestSuite_addTest", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"testGroupRole\": \"string\", \"test\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "test", "testGroupRole" ], "properties": { "testGroupRole": { "type": "string", "description": " The test group to which to add this test." }, "test": { "type": "string", "description": " The pointer to the test to add." } }, "description": "Model containing the method level model for TestSuite.addTest to decode json data to internal NFM-P object model" } } ], "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": "/restSasTestSuiteAddTest" }, "task": true }, { "name": "restSasTestSuiteAddTestedEntities", "summary": "rest_sas_TestSuite_addTestedEntities", "description": "rest_sas_TestSuite_addTestedEntities", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"testedEntities\": \"array\", \"generateTests\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "generateTests", "testedEntities" ], "properties": { "testedEntities": { "type": "array", "description": " A set of tested entity pointers to add.", "uniqueItems": true, "items": { "type": "string" } }, "generateTests": { "type": "boolean", "description": " Whether to generate tests for each tested entity that is added.If 'true' the tests for newly added tested entities will be generated.", "default": false } }, "description": "Model containing the method level model for TestSuite.addTestedEntities to decode json data to internal NFM-P object model" } } ], "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": "/restSasTestSuiteAddTestedEntities" }, "task": true }, { "name": "restSasTestSuiteAddTests", "summary": "rest_sas_TestSuite_addTests", "description": "rest_sas_TestSuite_addTests", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"testGroupRole\": \"string\", \"tests\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "testGroupRole", "tests" ], "properties": { "testGroupRole": { "type": "string", "description": " The test group to which to add these tests." }, "tests": { "type": "array", "description": " A set of test pointers to add.", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for TestSuite.addTests to decode json data to internal NFM-P object model" } } ], "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": "/restSasTestSuiteAddTests" }, "task": true }, { "name": "restSasTestSuiteGenerateTests", "summary": "rest_sas_TestSuite_generateTests", "description": "rest_sas_TestSuite_generateTests", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSasTestSuiteGenerateTests" }, "task": true }, { "name": "restSasTestSuiteGetNumberOfTests", "summary": "getNumberOfTests", "description": "Returns the number of tests in this testsuite Intention : RETRIEVER getNumberOfTests: instance-level retriever API getNumberOfTests of class sas.TestSuite instanceFullName : distinguished/instance name of called object The number of tests in this testsuite.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSasTestSuiteGetNumberOfTests" }, "task": true }, { "name": "restSasTestSuiteRemoveTest", "summary": "rest_sas_TestSuite_removeTest", "description": "rest_sas_TestSuite_removeTest", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"testGroupRole\": \"string\", \"test\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "test", "testGroupRole" ], "properties": { "testGroupRole": { "type": "string", "description": " The test group from which to remove this test." }, "test": { "type": "string", "description": " The pointer to the test to remove." } }, "description": "Model containing the method level model for TestSuite.removeTest to decode json data to internal NFM-P object model" } } ], "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": "/restSasTestSuiteRemoveTest" }, "task": true }, { "name": "restSasTestSuiteRemoveTests", "summary": "rest_sas_TestSuite_removeTests", "description": "rest_sas_TestSuite_removeTests", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"testGroupRole\": \"string\", \"test\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "test", "testGroupRole" ], "properties": { "testGroupRole": { "type": "string", "description": " The test group from which to remove these test." }, "test": { "type": "array", "description": " A set of test pointers to remove.", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for TestSuite.removeTests to decode json data to internal NFM-P object model" } } ], "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": "/restSasTestSuiteRemoveTests" }, "task": true }, { "name": "restSasTestedEntityExecute", "summary": "rest_sas_TestedEntity_execute", "description": "rest_sas_TestedEntity_execute", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSasTestedEntityExecute" }, "task": true }, { "name": "restSasqosMatchRenum", "summary": "rest_sasqos_Match_renum", "description": "rest_sasqos_Match_renum", "input": [ { "name": "body", "type": "object", "info": ": {\"aInNewEntryFullName\": \"string\", \"aInOldEntryFullName\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInNewEntryFullName": { "type": "string" }, "aInOldEntryFullName": { "type": "string" } }, "description": "Model containing the method level model for SecurityPolicyEntryDefinition.renum to decode json data to internal NFM-P object model" } } ], "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": "/restSasqosMatchRenum" }, "task": true }, { "name": "restSasqosMplsLspExpMapFindNetworkInterfaces", "summary": "findNetworkInterfaces", "description": "Intention : RETRIEVER findNetworkInterfaces: instance-level [object finder] (retriever) API findNetworkInterfaces of class sasqos.MplsLspExpMap instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSasqosMplsLspExpMapFindNetworkInterfaces" }, "task": true }, { "name": "restSasqosNQueueFindPorts", "summary": "findPorts", "description": "Intention : RETRIEVER findPorts: instance-level [object finder] (retriever) API findPorts of class sasqos.NQueue instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSasqosNQueueFindPorts" }, "task": true }, { "name": "restSasqosNetworkFindNetworkInterfaces", "summary": "findNetworkInterfaces", "description": "Intention : RETRIEVER findNetworkInterfaces: instance-level [object finder] (retriever) API findNetworkInterfaces of class sasqos.Network instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restSasqosNetworkFindNetworkInterfaces" }, "task": true }, { "name": "restSasqosNetworkFindPorts", "summary": "findPorts", "description": "Intention : RETRIEVER findPorts: instance-level [object finder] (retriever) API findPorts of class sasqos.Network instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restSasqosNetworkFindPorts" }, "task": true }, { "name": "restSasqosPortAccessEgressFindPorts", "summary": "findPorts", "description": "Intention : RETRIEVER findPorts: instance-level [object finder] (retriever) API findPorts of class sasqos.PortAccessEgress instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restSasqosPortAccessEgressFindPorts" }, "task": true }, { "name": "restSasqosPortSchedulerFindPorts", "summary": "findPorts", "description": "Intention : RETRIEVER findPorts: instance-level [object finder] (retriever) API findPorts of class sasqos.PortScheduler instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSasqosPortSchedulerFindPorts" }, "task": true }, { "name": "restSasqosQosPoolConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class sasqos.QosPool This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"shelfId\": 123, \"equipmentPointer\": \"string\", \"equipmentType\": 123, \"appType\": 123, \"appPool\": \"string\", \"slopePolicyPointer\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "shelfId": { "type": "integer" }, "equipmentPointer": { "type": "string" }, "equipmentType": { "type": "integer" }, "appType": { "type": "integer" }, "appPool": { "type": "string" }, "slopePolicyPointer": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo QosPoolConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restSasqosQosPoolConfigure" }, "task": true }, { "name": "restSasqosRemarkFindAccessInterfaces", "summary": "findAccessInterfaces", "description": "Intention : RETRIEVER findAccessInterfaces: instance-level [object finder] (retriever) API findAccessInterfaces of class sasqos.Remark instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSasqosRemarkFindAccessInterfaces" }, "task": true }, { "name": "restSasqosRemarkFindNetworkInterfaces", "summary": "findNetworkInterfaces", "description": "Intention : RETRIEVER findNetworkInterfaces: instance-level [object finder] (retriever) API findNetworkInterfaces of class sasqos.Remark instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSasqosRemarkFindNetworkInterfaces" }, "task": true }, { "name": "restSasqosRemarkFindPorts", "summary": "findPorts", "description": "Intention : RETRIEVER findPorts: instance-level [object finder] (retriever) API findPorts of class sasqos.Remark instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSasqosRemarkFindPorts" }, "task": true }, { "name": "restSasqosSystemResourceProfilePolicyFindCards", "summary": "findCards", "description": "Intention : RETRIEVER findCards: instance-level [object finder] (retriever) API findCards of class sasqos.SystemResourceProfilePolicy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSasqosSystemResourceProfilePolicyFindCards" }, "task": true }, { "name": "restSbtsperfSbtsPMPolicyFindSbtsNodes", "summary": "findSbtsNodes", "description": "Find all managed Sbts eNodeBs for the specified Performance Management polling policy assigned. Intention : RETRIEVER findSbtsNodes: class-level [object finder] (retriever) API findSbtsNodes of class sbtsperf.SbtsPMPolicy DescendantInfo: sbtsperf.SbtsNodePMPolicy", "input": [ { "name": "policyId", "type": "number", "info": ": 123", "required": false, "schema": { "title": "policyId", "type": "number" } } ], "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": "/restSbtsperfSbtsPMPolicyFindSbtsNodes" }, "task": true }, { "name": "restSbtsperfSbtsPMPolicyInvokeCatchup", "summary": "rest_sbtsperf_SbtsPMPolicy_invokeCatchup", "description": "rest_sbtsperf_SbtsPMPolicy_invokeCatchup", "input": [ { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restSbtsperfSbtsPMPolicyInvokeCatchup" }, "task": true }, { "name": "restSbtsperfSbtsPMPolicyInvokeSbtssCatchup", "summary": "rest_sbtsperf_SbtsPMPolicy_invokeSbtssCatchup", "description": "rest_sbtsperf_SbtsPMPolicy_invokeSbtssCatchup", "input": [ { "name": "body", "type": "object", "info": ": {\"networkElements\": \"array\", \"forceOnPMPolicyDown\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "forceOnPMPolicyDown", "networkElements" ], "properties": { "networkElements": { "type": "array", "description": " ", "uniqueItems": true, "items": { "type": "string" } }, "forceOnPMPolicyDown": { "type": "boolean", "description": " default:false", "default": false } }, "description": "Model containing the method level model for SbtsPMPolicy.invokeSbtssCatchup to decode json data to internal NFM-P object model" } } ], "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": "/restSbtsperfSbtsPMPolicyInvokeSbtssCatchup" }, "task": true }, { "name": "restScheduleScheduleManagerGetTimeZone", "summary": "getTimeZone", "description": "Intention : RETRIEVER getTimeZone: class-level retriever API getTimeZone on default instance scheduleManager of class schedule.ScheduleManager", "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": "/restScheduleScheduleManagerGetTimeZone" }, "task": true }, { "name": "restScheduleScheduledTaskShutDown", "summary": "rest_schedule_ScheduledTask_shutDown", "description": "rest_schedule_ScheduledTask_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restScheduleScheduledTaskShutDown" }, "task": true }, { "name": "restScheduleScheduledTaskStart", "summary": "rest_schedule_ScheduledTask_start", "description": "rest_schedule_ScheduledTask_start", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restScheduleScheduledTaskStart" }, "task": true }, { "name": "restScheduleScheduledTaskStop", "summary": "rest_schedule_ScheduledTask_stop", "description": "rest_schedule_ScheduledTask_stop", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restScheduleScheduledTaskStop" }, "task": true }, { "name": "restScheduleScheduledTaskTurnUp", "summary": "rest_schedule_ScheduledTask_turnUp", "description": "rest_schedule_ScheduledTask_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restScheduleScheduledTaskTurnUp" }, "task": true }, { "name": "restScriptAbstractScriptChangeScriptVersion", "summary": "rest_script_AbstractScript_changeScriptVersion", "description": "rest_script_AbstractScript_changeScriptVersion", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restScriptAbstractScriptChangeScriptVersion" }, "task": true }, { "name": "restScriptAbstractScriptConfigScriptVersion", "summary": "configScriptVersion", "description": "This method creates a version of the auto-config script template (and deletes the older version if exists). Intention : MODIFIER configScriptVersion: instance-level [hierarchical administrative configuration/modification] (modifier) API configScriptVersion of class script.AbstractScript This API follows hierarchical config model rules. DescendantInfo: script.ControlScript DescendantInfo: script.Script DescendantInfo: script.XmlApiConfigTemplate DescendantInfo: script.AbstractXmlApiS...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"versionConfigInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}, \"bodyScript\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "bodyScript", "versionConfigInfo" ], "properties": { "versionConfigInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" }, "bodyScript": { "type": "array", "description": " The script version body (list of commands).", "items": { "type": "string" } } }, "description": "Model containing the method level model for AbstractScript.configScriptVersion to decode json data to internal NFM-P object model" } } ], "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": "/restScriptAbstractScriptConfigScriptVersion" }, "task": true }, { "name": "restScriptAbstractScriptConfigureScript", "summary": "configureScript", "description": "This method modifies script information. Intention : MODIFIER configureScript: instance-level [hierarchical administrative configuration/modification] (modifier) API configureScript of class script.AbstractScript This API follows hierarchical config model rules. DescendantInfo: script.ControlScript DescendantInfo: script.Script DescendantInfo: script.XmlApiConfigTemplate DescendantInfo: script.AbstractXmlApiScript DescendantInfo: autoconfig.AutoConfigSrcProfile DescendantInfo: a...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restScriptAbstractScriptConfigureScript" }, "task": true }, { "name": "restScriptAbstractScriptConfigureTarget", "summary": "configureTarget", "description": "This method creates a target associated to a script. Intention : MODIFIER configureTarget: instance-level [hierarchical administrative configuration/modification] (modifier) API configureTarget of class script.AbstractScript This API follows hierarchical config model rules. DescendantInfo: script.ControlScript DescendantInfo: script.Script DescendantInfo: script.XmlApiConfigTemplate DescendantInfo: script.AbstractXmlApiScript DescendantInfo: autoconfig.AutoConfigSrcProfile Descen...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restScriptAbstractScriptConfigureTarget" }, "task": true }, { "name": "restScriptAbstractScriptConfigureTargets", "summary": "configureTargets", "description": "This method creates multiple targets associated to a script. Intention : MODIFIER configureTargets: instance-level [hierarchical administrative configuration/modification] (modifier) API configureTargets of class script.AbstractScript This API follows hierarchical config model rules. DescendantInfo: script.ControlScript DescendantInfo: script.Script DescendantInfo: script.XmlApiConfigTemplate DescendantInfo: script.AbstractXmlApiScript DescendantInfo: autoconfig.AutoConfigSrcProfi...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restScriptAbstractScriptConfigureTargets" }, "task": true }, { "name": "restScriptAbstractScriptCreateScriptVersion", "summary": "createScriptVersion", "description": "This method creates a version of the script. Intention : MODIFIER createScriptVersion: instance-level [administrative creation] (modifier) API createScriptVersion of class script.AbstractScript DescendantInfo: script.ControlScript DescendantInfo: script.Script DescendantInfo: script.XmlApiConfigTemplate DescendantInfo: script.AbstractXmlApiScript DescendantInfo: autoconfig.AutoConfigSrcProfile DescendantInfo: autoconfig.AutoConfigDestProfile DescendantInfo: script.XmlApiScript...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"versionConfigInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}, \"bodyScript\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "bodyScript", "versionConfigInfo" ], "properties": { "versionConfigInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" }, "bodyScript": { "type": "array", "description": " The script version body (list of commands).", "items": { "type": "string" } } }, "description": "Model containing the method level model for AbstractScript.createScriptVersion to decode json data to internal NFM-P object model" } } ], "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": "/restScriptAbstractScriptCreateScriptVersion" }, "task": true }, { "name": "restScriptAbstractVersionGetScriptContents", "summary": "getScriptContents", "description": "This method returns the script version contents (commands). Intention : RETRIEVER getScriptContents: class-level retriever API getScriptContents of class script.AbstractVersion DescendantInfo: script.ControlScriptVersion DescendantInfo: script.Version DescendantInfo: script.XmlApiVersion DescendantInfo: autoconfig.AutoConfigScript DescendantInfo: autoconfig.AutoConfigTemplate The script versions body.", "input": [ { "name": "objectFullName", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectFullName", "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": "/restScriptAbstractVersionGetScriptContents" }, "task": true }, { "name": "restScriptBundleAddScripts", "summary": "rest_script_Bundle_addScripts", "description": "rest_script_Bundle_addScripts", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restScriptBundleAddScripts" }, "task": true }, { "name": "restScriptBundleDeleteBundleAndAssociatedScripts", "summary": "rest_script_Bundle_deleteBundleAndAssociatedScripts", "description": "rest_script_Bundle_deleteBundleAndAssociatedScripts", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restScriptBundleDeleteBundleAndAssociatedScripts" }, "task": true }, { "name": "restScriptBundleRemoveScripts", "summary": "rest_script_Bundle_removeScripts", "description": "rest_script_Bundle_removeScripts", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restScriptBundleRemoveScripts" }, "task": true }, { "name": "restScriptControlScriptAssociateExecutableScript", "summary": "associateExecutableScript", "description": "This method will create an association (binding) between this control script and another script. Intention : MODIFIER associateExecutableScript: instance-level modifier API associateExecutableScript of class script.ControlScript instanceFullName : distinguished/instance name of called object Returns the object the input parameter 'associatedObjectPointer' is referring to.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restScriptControlScriptAssociateExecutableScript" }, "task": true }, { "name": "restScriptControlScriptAssociateHandlerScript", "summary": "associateHandlerScript", "description": "This method will create an association (binding) between this control script and either another script. Intention : MODIFIER associateHandlerScript: instance-level modifier API associateHandlerScript of class script.ControlScript instanceFullName : distinguished/instance name of called object Returns the object the input parameter 'associatedObjectPointer' is referring to.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restScriptControlScriptAssociateHandlerScript" }, "task": true }, { "name": "restScriptResultGetResultBody", "summary": "getResultBody", "description": "This method returns the result body of the specified result object. Intention : RETRIEVER getResultBody: class-level retriever API getResultBody of class script.Result The body of the result.", "input": [ { "name": "objectFullName", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectFullName", "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": "/restScriptResultGetResultBody" }, "task": true }, { "name": "restScriptResultManagerSaveResult", "summary": "saveResult", "description": "This method saves a given result to result management. Intention : MODIFIER saveResult: instance-level modifier API saveResult on default instance result-manager of class script.ResultManager The full name of the newly created result object in result management.", "input": [ { "name": "body", "type": "object", "info": ": {\"resultConfigInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}, \"resultBody\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "resultBody", "resultConfigInfo" ], "properties": { "resultConfigInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" }, "resultBody": { "type": "string", "description": " The result text from the execution of the target script." } }, "description": "Model containing the method level model for ResultManager.saveResult to decode json data to internal NFM-P object model" } } ], "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": "/restScriptResultManagerSaveResult" }, "task": true }, { "name": "restScriptScriptManagerCancelExecution", "summary": "cancelExecution", "description": "This method is used to cancel the execution of a script. If a script is currently executing, it will not cancel it, it must wait until the script is finished. It will cancel scripts that are queued to execute. Intention : RETRIEVER cancelExecution: class-level retriever API cancelExecution on default instance script-manager of class script.ScriptManager The full name list of all the targets that could be cancelled.", "input": [ { "name": "body", "type": "object", "info": ": {\"clientId\": \"string\", \"targetScriptResultObjectFullNameListToBeCanceled\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "clientId", "targetScriptResultObjectFullNameListToBeCanceled" ], "properties": { "clientId": { "type": "string", "description": " The client ID of the client that requested the execution of the target script." }, "targetScriptResultObjectFullNameListToBeCanceled": { "type": "array", "description": " The list of target scripts to cancel.", "items": { "type": "string" } } }, "description": "Model containing the method level model for ScriptManager.cancelExecution to decode json data to internal NFM-P object model" } } ], "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": "/restScriptScriptManagerCancelExecution" }, "task": true }, { "name": "restScriptScriptManagerCancelRunningCliExecution", "summary": "rest_script_ScriptManager_cancelRunningCliExecution", "description": "rest_script_ScriptManager_cancelRunningCliExecution", "input": [ { "name": "body", "type": "object", "info": ": {\"aInTargetScriptFdn\": \"string\", \"clientId\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "clientId" ], "properties": { "aInTargetScriptFdn": { "type": "string" }, "clientId": { "type": "string", "description": " The client ID of the client that requested the execution of the target script." } }, "description": "Model containing the method level model for ScriptManager.cancelRunningCliExecution to decode json data to internal NFM-P object model" } } ], "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": "/restScriptScriptManagerCancelRunningCliExecution" }, "task": true }, { "name": "restScriptScriptManagerCancelScriptFlow", "summary": "cancelScriptFlow", "description": "This method will request to stop a running script flow. It is not guaranteed that the script flow will be aborted. Intention : RETRIEVER cancelScriptFlow: class-level retriever API cancelScriptFlow on default instance script-manager of class script.ScriptManager Returns true if the request was succesfully submitted (it does not mean that the script execution was actually stopped). Returns false if the cancel request could not be submitted (the script already finished execution or user has n...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"clientId\": \"string\", \"targetScriptResultObjectFullNameToBeCanceled\": \"string\", \"targetScriptConfig\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"mtosi_id\": 123, \"targetName\": \"string\", \"targetObjectFullName\": \"string\", \"description\": \"string\", \"versionFullName\": \"string\", \"mtosi_version\": 123, \"scriptDisplayName\": \"string\", \"versionMode\": 123, \"executionDate\": 123, \"status\": 123, \"creationTime\": 123, \"numberOfExecutions\": 123, \"numberOfSavedResults\": 123, \"lastExecutedUser\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "clientId", "targetScriptConfig", "targetScriptResultObjectFullNameToBeCanceled" ], "properties": { "clientId": { "type": "string", "description": " Identifies the client ID that requested the execution (used for sending an event to the specific client when execution is complete)." }, "targetScriptResultObjectFullNameToBeCanceled": { "type": "string", "description": " The FDN of target script result object to cancel.This result object is returned by method executeScriptFlow." }, "targetScriptConfig": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "mtosi_id": { "type": "integer" }, "targetName": { "type": "string" }, "targetObjectFullName": { "type": "string" }, "description": { "type": "string" }, "versionFullName": { "type": "string" }, "mtosi_version": { "type": "integer" }, "scriptDisplayName": { "type": "string" }, "versionMode": { "type": "integer" }, "executionDate": { "type": "integer" }, "status": { "type": "integer" }, "creationTime": { "type": "integer" }, "numberOfExecutions": { "type": "integer" }, "numberOfSavedResults": { "type": "integer" }, "lastExecutedUser": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo TargetScriptConfigInfo. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for ScriptManager.cancelScriptFlow to decode json data to internal NFM-P object model" } } ], "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": "/restScriptScriptManagerCancelScriptFlow" }, "task": true }, { "name": "restScriptScriptManagerConfigure", "summary": "configure", "description": "Create and modify a script through the script manager. Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure on default instance script-manager of class script.ScriptManager This API follows hierarchical config model rules. The newly created scripts full name.", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restScriptScriptManagerConfigure" }, "task": true }, { "name": "restScriptScriptManagerExecuteCLIScript", "summary": "executeCLIScript", "description": "This method is called to execute target scripts. For example: <script.ScriptManager.executeCLIScript xmlns=\"xmlapi_1.0\"> <isSynchronized>true< isSynchronized> <clientId>user@1< clientId> <targetScriptFullNameList> <pointer>script-manager:script-4:target-script-1< pointer> < targetScriptFullNameList> <resultFilter>< resultFilter> < script.ScriptManager.executeCLIScript> Intention : RETRIEVER executeCLIScript: clas...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"isSynchronized\": \"boolean\", \"clientId\": \"string\", \"targetScriptFullNameList\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "clientId", "isSynchronized", "targetScriptFullNameList" ], "properties": { "isSynchronized": { "type": "boolean", "description": " Identifies if the call to execute the script should wait until all scripts have been executed. True to wait, false otherwise.", "default": false }, "clientId": { "type": "string", "description": " Identifies the client ID that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "targetScriptFullNameList": { "type": "array", "description": " Identifies the list of target scripts to execute.", "items": { "type": "string" } } }, "description": "Model containing the method level model for ScriptManager.executeCLIScript to decode json data to internal NFM-P object model" } } ], "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": "/restScriptScriptManagerExecuteCLIScript" }, "task": true }, { "name": "restScriptScriptManagerExecuteCLITargetScripts", "summary": "executeCLITargetScripts", "description": "This method is called to execute target scripts with runtime parameters. For example: <script.ScriptManager.executeCLITargetScripts xmlns=\"xmlapi_1.0\"> <isSynchronized>true <clientId>user@1< clientId> <listOfTargetScriptConfigInfo> <script.TargetScript> <actionMask> <bit>create< bit> < actionMask> <objectFullName>script-manager:script-6:target-script-1< objectFullName> <script.TargetParameter-Set> <script.TargetPa...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"isSynchronized\": \"boolean\", \"clientId\": \"string\", \"listOfTargetScriptConfigInfo\": [{\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}]}", "required": false, "schema": { "type": "object", "required": [ "clientId", "isSynchronized", "listOfTargetScriptConfigInfo" ], "properties": { "isSynchronized": { "type": "boolean", "description": " Identifies if the call to execute the script should wait until all scripts have been executed. True to wait, false otherwise.", "default": false }, "clientId": { "type": "string", "description": " Identifies the client ID that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "listOfTargetScriptConfigInfo": { "type": "array", "description": " The configuration info for the targets when executing (runtime parameters).", "items": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for ScriptManager.executeCLITargetScripts to decode json data to internal NFM-P object model" } } ], "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": "/restScriptScriptManagerExecuteCLITargetScripts" }, "task": true }, { "name": "restScriptScriptManagerExecuteScript", "summary": "executeScript", "description": "This method is called to execute target scripts. For example: <script.ScriptManager.executeScript xmlns=\"xmlapi_1.0\"> <isSynchronized>true< isSynchronized> <clientId>user@1< clientId> <targetScriptFullNameList> <pointer>script-manager:xmlApiScript-6:target-script-1< pointer> < targetScriptFullNameList> < script.ScriptManager.executeScript> Intention : RETRIEVER executeScript: class-level retriever API executeScript on defaul...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"isSynchronized\": \"boolean\", \"clientId\": \"string\", \"targetScriptFullNameList\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "clientId", "isSynchronized", "targetScriptFullNameList" ], "properties": { "isSynchronized": { "type": "boolean", "description": " Identifies if the call to execute the script should wait until all scripts have been executed. True to wait, false otherwise.", "default": false }, "clientId": { "type": "string", "description": " Identifies the client ID that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "targetScriptFullNameList": { "type": "array", "description": " Identifies the list of target scripts to execute.", "items": { "type": "string" } } }, "description": "Model containing the method level model for ScriptManager.executeScript to decode json data to internal NFM-P object model" } } ], "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": "/restScriptScriptManagerExecuteScript" }, "task": true }, { "name": "restScriptScriptManagerExecuteScriptFlow", "summary": "executeScriptFlow", "description": "This method is called to execute a script synchronously. Always latest versions are used, and target information is not stored, instead it is passed in during execution. Intention : RETRIEVER executeScriptFlow: class-level retriever API executeScriptFlow on default instance script-manager of class script.ScriptManager The ScriptFlowExecutionResult object identifying the status and the result body of the executed script.", "input": [ { "name": "body", "type": "object", "info": ": {\"isSynchronized\": \"boolean\", \"clientId\": \"string\", \"systemInvokationId\": 123, \"scriptName\": \"string\", \"targetScriptConfig\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"mtosi_id\": 123, \"targetName\": \"string\", \"targetObjectFullName\": \"string\", \"description\": \"string\", \"versionFullName\": \"string\", \"mtosi_version\": 123, \"scriptDisplayName\": \"string\", \"versionMode\": 123, \"executionDate\": 123, \"status\": 123, \"creationTime\": 123, \"numberOfExecutions\": 123, \"numberOfSavedResults\": 123, \"lastExecutedUser\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "clientId", "isSynchronized", "scriptName", "systemInvokationId", "targetScriptConfig" ], "properties": { "isSynchronized": { "type": "boolean", "description": " Identifies if the call to execute the script should wait until all scripts have been executed. True to wait, false otherwise.", "default": false }, "clientId": { "type": "string", "description": " Identifies the client ID that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "systemInvokationId": { "type": "integer", "description": " Identifies the client request ID that is uniquely identifying this particular request within the client.The client is responsible to generate a unique ID for each request.This value will be set on the script execution events that are created as a result of executing this request." }, "scriptName": { "type": "string", "description": " Identifies the script to execute (version is not needed as latest version is executed).This is the fully distinguished name (FDN) of the script to be executed.Alternatively the unique name of the script can be used (scriptName of AbstractScript)." }, "targetScriptConfig": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "mtosi_id": { "type": "integer" }, "targetName": { "type": "string" }, "targetObjectFullName": { "type": "string" }, "description": { "type": "string" }, "versionFullName": { "type": "string" }, "mtosi_version": { "type": "integer" }, "scriptDisplayName": { "type": "string" }, "versionMode": { "type": "integer" }, "executionDate": { "type": "integer" }, "status": { "type": "integer" }, "creationTime": { "type": "integer" }, "numberOfExecutions": { "type": "integer" }, "numberOfSavedResults": { "type": "integer" }, "lastExecutedUser": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo TargetScriptConfigInfo. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for ScriptManager.executeScriptFlow to decode json data to internal NFM-P object model" } } ], "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": "/restScriptScriptManagerExecuteScriptFlow" }, "task": true }, { "name": "restScriptScriptManagerExecuteSystemScripts", "summary": "executeSystemScripts", "description": "This method is called to execute system scripts scripts. Versions are not supported with system scripts, and target information is not stored, instead it is passed in during execution. Intention : RETRIEVER executeSystemScripts: class-level retriever API executeSystemScripts on default instance script-manager of class script.ScriptManager The list of TargetScriptResultInfo objects identifying the status of the executed target scripts.", "input": [ { "name": "body", "type": "object", "info": ": {\"isSynchronized\": \"boolean\", \"clientId\": \"string\", \"scriptClassName\": \"string\", \"scriptName\": \"string\", \"listOfSystemScriptTargetConfigInfo\": [{\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}]}", "required": false, "schema": { "type": "object", "required": [ "clientId", "isSynchronized", "listOfSystemScriptTargetConfigInfo", "scriptClassName", "scriptName" ], "properties": { "isSynchronized": { "type": "boolean", "description": " Identifies if the call to execute the script should wait until all scripts have been executed. True to wait, false otherwise.", "default": false }, "clientId": { "type": "string", "description": " Identifies the client Id that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "scriptClassName": { "type": "string", "description": " Identifies the script class name to execute." }, "scriptName": { "type": "string", "description": " Identifies the script to execute (version is not needed as versions are not supported for system scripts)." }, "listOfSystemScriptTargetConfigInfo": { "type": "array", "description": " The configuration info for the targets when executing.", "items": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for ScriptManager.executeSystemScripts to decode json data to internal NFM-P object model" } } ], "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": "/restScriptScriptManagerExecuteSystemScripts" }, "task": true }, { "name": "restScriptScriptManagerExecuteTargetScripts", "summary": "executeTargetScripts", "description": "This method is called to execute target scripts with runtime parameters. For example: <script.ScriptManager.executeTargetScripts xmlns=\"xmlapi_1.0\"> <isSynchronized>true< isSynchronized> <clientId>user@1< clientId> <listOfTargetScriptConfigInfo> <script.TargetScript> <actionMask> <bit>create< bit> < actionMask> <objectFullName>script-manager:xmlApiScript-55:target-script-3< objectFullName> <script.TargetParameter-Set>...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"isSynchronized\": \"boolean\", \"clientId\": \"string\", \"listOfTargetScriptConfigInfo\": [{\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}]}", "required": false, "schema": { "type": "object", "required": [ "clientId", "isSynchronized", "listOfTargetScriptConfigInfo" ], "properties": { "isSynchronized": { "type": "boolean", "description": " Identifies if the call to execute the script should wait until all scripts have been executed. True to wait, false otherwise.", "default": false }, "clientId": { "type": "string", "description": " Identifies the client ID that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "listOfTargetScriptConfigInfo": { "type": "array", "description": " The configuration info for the targets when executing (runtime parameters).", "items": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for ScriptManager.executeTargetScripts to decode json data to internal NFM-P object model" } } ], "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": "/restScriptScriptManagerExecuteTargetScripts" }, "task": true }, { "name": "restScriptScriptManagerExecuteTargetScriptsWithParameters", "summary": "executeTargetScriptsWithParameters", "description": "Intention : RETRIEVER executeTargetScriptsWithParameters: class-level retriever API executeTargetScriptsWithParameters on default instance script-manager of class script.ScriptManager The list of TargetScriptResultInfo objects identifying the status of the executed target scripts.", "input": [ { "name": "body", "type": "object", "info": ": {\"isSynchronized\": \"boolean\", \"clientId\": \"string\", \"targetScriptFullNameList\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "clientId", "isSynchronized", "targetScriptFullNameList" ], "properties": { "isSynchronized": { "type": "boolean", "description": " Identifies if the call to execute the script should wait until all scripts have been executed. True to wait, false otherwise.", "default": false }, "clientId": { "type": "string", "description": " Identifies the client ID that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "targetScriptFullNameList": { "type": "array", "description": " Identifies the list of target scripts to execute.", "items": { "type": "string" } } }, "description": "Model containing the method level model for ScriptManager.executeTargetScriptsWithParameters to decode json data to internal NFM-P object model" } } ], "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": "/restScriptScriptManagerExecuteTargetScriptsWithParameters" }, "task": true }, { "name": "restScriptScriptManagerGetBodyOfTargetScriptResult", "summary": "getBodyOfTargetScriptResult", "description": "This method is called to get the result of an executed target script. Intention : RETRIEVER getBodyOfTargetScriptResult: class-level retriever API getBodyOfTargetScriptResult on default instance script-manager of class script.ScriptManager The result of the executed script (returned as a string).", "input": [ { "name": "targetScriptResultObjectFullName", "type": "string", "info": ": string", "required": false, "schema": { "title": "targetScriptResultObjectFullName", "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": "/restScriptScriptManagerGetBodyOfTargetScriptResult" }, "task": true }, { "name": "restScriptScriptManagerPreviewScriptWithParameters", "summary": "previewScriptWithParameters", "description": "Intention : RETRIEVER previewScriptWithParameters: class-level retriever API previewScriptWithParameters on default instance script-manager of class script.ScriptManager The preview result.", "input": [ { "name": "body", "type": "object", "info": ": {\"scriptFullName\": \"string\", \"parameters\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "parameters", "scriptFullName" ], "properties": { "scriptFullName": { "type": "string", "description": " Identifies the script to preview (version is not needed as latest version is previewed)." }, "parameters": { "type": "object", "description": " The configuration info for the targets when previewing.", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "parameterName": { "type": "string" }, "value": { "type": "string" }, "checkBoxValueDefined": { "type": "boolean", "default": false }, "unset": { "type": "boolean", "default": false }, "runtime": { "type": "boolean", "default": false }, "paramType": { "type": "integer" }, "mode": { "type": "integer" } }, "description": "Model containing the method level model for Interface ConfigInfo TargetParameterConfigInfo. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for ScriptManager.previewScriptWithParameters to decode json data to internal NFM-P object model" } } ], "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": "/restScriptScriptManagerPreviewScriptWithParameters" }, "task": true }, { "name": "restScriptTargetParameterConfigure", "summary": "configure", "description": "This method is used to create or configure target parameters. Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class script.TargetParameter This API follows hierarchical config model rules. DescendantInfo: script.LargeTextTargetParameter DescendantInfo: script.TargetParameterItem DescendantInfo: script.JsonTargetParameter DescendantInfo: script.TargetParameterList instanceFullName : distinguished/ins...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restScriptTargetParameterConfigure" }, "task": true }, { "name": "restScriptTargetScriptCancelExecution", "summary": "cancelExecution", "description": "This method is used to cancel the execution of a target script. If a target script is currently executing, it will not cancel it, it must wait until the target script is finished. It will cancel a target script that is queued to execute. Intention : RETRIEVER cancelExecution: instance-level retriever API cancelExecution of class script.TargetScript instanceFullName : distinguished/instance name of called object True if it could be cancelled, false otherwise.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"clientId\": \"string\", \"targetScriptResultObjectFullNameListToBeCanceled\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "clientId", "targetScriptResultObjectFullNameListToBeCanceled" ], "properties": { "clientId": { "type": "string", "description": " The client ID of the client that requested the execution of the target script." }, "targetScriptResultObjectFullNameListToBeCanceled": { "type": "array", "description": " The list of target scripts to cancel.", "items": { "type": "string" } } }, "description": "Model containing the method level model for ScriptManager.cancelExecution to decode json data to internal NFM-P object model" } } ], "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": "/restScriptTargetScriptCancelExecution" }, "task": true }, { "name": "restScriptTargetScriptConfigure", "summary": "configure", "description": "This method is used to configure the target script. It can be used to modify the parameters or the name, but it can not be used to change the version (see AbstractScript for more details). Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class script.TargetScript This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object The target script full name.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restScriptTargetScriptConfigure" }, "task": true }, { "name": "restScriptTargetScriptExecuteCLIScript", "summary": "executeCLIScript", "description": "This method is used to execute a CLI target script. For example: <script.TargetScript.executeCLIScript xmlns=\"xmlapi_1.0\"> <isSynchronized>true< isSynchronized> <clientId>user@1< clientId> <instanceFullName>script-manager:script-4:target-script-1< instanceFullName> <resultFilter>< resultFilter> < script.TargetScript.executeCLIScript> Intention : RETRIEVER executeCLIScript: instance-level retriever API executeCLIScript of cl...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"isSynchronized\": \"boolean\", \"clientId\": \"string\", \"targetScriptFullNameList\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "clientId", "isSynchronized", "targetScriptFullNameList" ], "properties": { "isSynchronized": { "type": "boolean", "description": " Identifies if the call to execute the script should wait until all scripts have been executed. True to wait, false otherwise.", "default": false }, "clientId": { "type": "string", "description": " Identifies the client ID that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "targetScriptFullNameList": { "type": "array", "description": " Identifies the list of target scripts to execute.", "items": { "type": "string" } } }, "description": "Model containing the method level model for ScriptManager.executeCLIScript to decode json data to internal NFM-P object model" } } ], "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": "/restScriptTargetScriptExecuteCLIScript" }, "task": true }, { "name": "restScriptTargetScriptExecuteCLITargetScript", "summary": "executeCLITargetScript", "description": "This method is used to execute a target script with runtime parameters. For example: <script.TargetScript.executeCLITargetScript xmlns=\"xmlapi_1.0\"> <isSynchronized>true< isSynchronized> <clientId>user@1< clientId> <instanceFullName>script-manager:script-17:target-script-1< instanceFullName> <configInfo> <item> <key>script-manager:script-17:target-script-1:target-parameter-portId< key> <value> <script.TargetParameter> &...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"isSynchronized\": \"boolean\", \"clientId\": \"string\", \"configInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "clientId", "configInfo", "isSynchronized" ], "properties": { "isSynchronized": { "type": "boolean", "description": " Identifies if the call to execute the script should wait until the script has been executed. True to wait, false otherwise.", "default": false }, "clientId": { "type": "string", "description": " Identifies the client ID that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "configInfo": { "type": "object", "description": " The configuration info for the targets when executing (runtime parameters).", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for TargetScript.executeCLITargetScript to decode json data to internal NFM-P object model" } } ], "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": "/restScriptTargetScriptExecuteCLITargetScript" }, "task": true }, { "name": "restScriptTargetScriptExecuteScript", "summary": "executeScript", "description": "This method is used to execute a target script. For example: <script.TargetScript.executeScript xmlns=\"xmlapi_1.0\"> <isSynchronized>true< isSynchronized> <clientId>user@1< clientId> <instanceFullName>script-manager:xmlApiScript-56:target-script-3< instanceFullName> <resultFilter>< resultFilter> < script.TargetScript.executeScript> Intention : RETRIEVER executeScript: instance-level retriever API executeScript of class scrip...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"isSynchronized\": \"boolean\", \"clientId\": \"string\", \"targetScriptFullNameList\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "clientId", "isSynchronized", "targetScriptFullNameList" ], "properties": { "isSynchronized": { "type": "boolean", "description": " Identifies if the call to execute the script should wait until all scripts have been executed. True to wait, false otherwise.", "default": false }, "clientId": { "type": "string", "description": " Identifies the client ID that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "targetScriptFullNameList": { "type": "array", "description": " Identifies the list of target scripts to execute.", "items": { "type": "string" } } }, "description": "Model containing the method level model for ScriptManager.executeScript to decode json data to internal NFM-P object model" } } ], "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": "/restScriptTargetScriptExecuteScript" }, "task": true }, { "name": "restScriptTargetScriptExecuteTargetScript", "summary": "executeTargetScript", "description": "This method is used to execute a target script with runtime parameters. For example: <script.TargetScript.executeTargetScript xmlns=\"xmlapi_1.0\"> <isSynchronized>true< isSynchronized> <clientId>user@1< clientId> <instanceFullName>script-manager:xmlApiScript-55:target-script-3< instanceFullName> <configInfo> <item> <key>script-manager:xmlApiScript-55:target-script-3:target-parameter-classToFind< key> <value> <script.T...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"isSynchronized\": \"boolean\", \"clientId\": \"string\", \"configInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "clientId", "configInfo", "isSynchronized" ], "properties": { "isSynchronized": { "type": "boolean", "description": " Identifies if the call to execute the script should wait until the script has been executed. True to wait, false otherwise.", "default": false }, "clientId": { "type": "string", "description": " Identifies the client Id that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "configInfo": { "type": "object", "description": " The configuration info for the targets when executing (runtime parameters).", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for TargetScript.executeTargetScript to decode json data to internal NFM-P object model" } } ], "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": "/restScriptTargetScriptExecuteTargetScript" }, "task": true }, { "name": "restScriptTargetScriptPreview", "summary": "preview", "description": "This method is used to preview targets based on the script version and the parameters configured for the target. Intention : RETRIEVER preview: instance-level retriever API preview of class script.TargetScript instanceFullName : distinguished/instance name of called object The preview result.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object", "additionalProperties": { "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": "/restScriptTargetScriptPreview" }, "task": true }, { "name": "restScriptTargetScriptResultGetTargetScriptResult", "summary": "getTargetScriptResult", "description": "This method returns the target script result for the specified full name. Intention : RETRIEVER getTargetScriptResult: class-level retriever API getTargetScriptResult of class script.TargetScriptResult The target script result.", "input": [ { "name": "objectFullName", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectFullName", "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": "/restScriptTargetScriptResultGetTargetScriptResult" }, "task": true }, { "name": "restScriptVelocityTemplateReload", "summary": "rest_script_VelocityTemplate_reload", "description": "rest_script_VelocityTemplate_reload", "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": "/restScriptVelocityTemplateReload" }, "task": true }, { "name": "restScriptVelocityTemplateStore", "summary": "store", "description": "Create modify the script and load it in Velocity engine. Intention : MODIFIER store: class-level modifier API store of class script.VelocityTemplate The name of the newly defined or changed OSSI command. Empty string if the template passed in was identical to an already defined one.", "input": [ { "name": "body", "type": "object", "info": ": {\"body\": \"string\", \"reloadTemplates\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "body", "reloadTemplates" ], "properties": { "body": { "type": "string", "description": " Template body." }, "reloadTemplates": { "type": "boolean", "description": " Reload all velocity templates after storing thisone (useful when only one templates gets stored)(invoke method 'reload')", "default": false } }, "description": "Model containing the method level model for VelocityTemplate.store to decode json data to internal NFM-P object model" } } ], "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": "/restScriptVelocityTemplateStore" }, "task": true }, { "name": "restScriptXmlApiConfigTemplateAssociateTemplate", "summary": "associateTemplate", "description": "This method will create an association (binding) between this template and either a) another template, or b) a templatable object (an object that was created from this template). Intention : MODIFIER associateTemplate: instance-level modifier API associateTemplate of class script.XmlApiConfigTemplate instanceFullName : distinguished/instance name of called object Returns the object the input parameter 'associatedObjectPointer' is referring to.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restScriptXmlApiConfigTemplateAssociateTemplate" }, "task": true }, { "name": "restScriptXmlApiConfigTemplateConvertOldTemplates", "summary": "convertOldTemplates", "description": "This method is used to generate a template. Depending on parameters specified by 'templateParams' the template can be generated from a class or an instance. Intention : MODIFIER convertOldTemplates: class-level modifier API convertOldTemplates of class script.XmlApiConfigTemplate The generated templates.", "input": [ { "name": "body", "type": "object", "info": ": {\"oldTemplatePointers\": \"array\", \"templateConfiguration\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"mtosi_id\": 123, \"scriptName\": \"string\", \"mtosi_description\": \"string\", \"mtosi_type\": \"string\", \"scriptState\": 123, \"scriptMode\": 123, \"contentType\": 123, \"scriptType\": 123, \"useLatestVersion\": \"boolean\", \"autoSaveResult\": \"boolean\", \"reserveTargets\": \"boolean\", \"id\": 123, \"displayedName\": \"string\", \"description\": \"string\", \"bundleId\": 123, \"scopeOfCommandProfilePointer\": \"string\", \"configuredClass\": \"string\", \"configuredClassCategories\": \"string\", \"includeChildrenCreation\": \"boolean\", \"commandType\": 123, \"showCreatedObject\": \"boolean\"}, \"updateExistingServices\": \"boolean\", \"updateExistingSites\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "oldTemplatePointers", "templateConfiguration", "updateExistingServices", "updateExistingSites" ], "properties": { "oldTemplatePointers": { "type": "array", "description": " The old templates that has to be converted.Must be instance of class 'template.Template'.", "items": { "type": "string" } }, "templateConfiguration": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "mtosi_id": { "type": "integer" }, "scriptName": { "type": "string" }, "mtosi_description": { "type": "string" }, "mtosi_type": { "type": "string" }, "scriptState": { "type": "integer" }, "scriptMode": { "type": "integer" }, "contentType": { "type": "integer" }, "scriptType": { "type": "integer" }, "useLatestVersion": { "type": "boolean", "default": false }, "autoSaveResult": { "type": "boolean", "default": false }, "reserveTargets": { "type": "boolean", "default": false }, "id": { "type": "integer" }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "bundleId": { "type": "integer" }, "scopeOfCommandProfilePointer": { "type": "string" }, "configuredClass": { "type": "string" }, "configuredClassCategories": { "type": "string" }, "includeChildrenCreation": { "type": "boolean", "default": false }, "commandType": { "type": "integer" }, "showCreatedObject": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface ConfigInfo XmlApiConfigTemplateConfigInfo. to decode json data to internal NFM-P object model" }, "updateExistingServices": { "type": "boolean", "description": " All services created from the old service template will be updated.", "default": false }, "updateExistingSites": { "type": "boolean", "description": " The service sites of all services created from the old service template will be updated.", "default": false } }, "description": "Model containing the method level model for XmlApiConfigTemplate.convertOldTemplates to decode json data to internal NFM-P object model" } } ], "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": "/restScriptXmlApiConfigTemplateConvertOldTemplates" }, "task": true }, { "name": "restScriptXmlApiConfigTemplateExecute", "summary": "execute", "description": "This method is used to configure (e.g. create) an object from a template. Intention : MODIFIER execute: instance-level modifier API execute of class script.XmlApiConfigTemplate instanceFullName : distinguished/instance name of called object The full names of the configured objects.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object", "additionalProperties": { "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": "/restScriptXmlApiConfigTemplateExecute" }, "task": true }, { "name": "restScriptXmlApiConfigTemplateExecuteMulti", "summary": "executeMulti", "description": "This method is used to configure (e.g. create) an object with children from a template. Intention : MODIFIER executeMulti: instance-level modifier API executeMulti of class script.XmlApiConfigTemplate instanceFullName : distinguished/instance name of called object The full names of the configured objects.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"templateFdn\": \"string\", \"targetParam\": \"object\", \"children\": [{\"objectClassName\": \"string\", \"templateFdn\": \"string\", \"targetParam\": \"object\", \"children\": \"array\"}]}", "required": false, "schema": { "type": "object", "required": [ "children", "objectClassName", "targetParam", "templateFdn" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "templateFdn": { "type": "string" }, "targetParam": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "parameterName": { "type": "string" }, "value": { "type": "string" }, "checkBoxValueDefined": { "type": "boolean", "default": false }, "unset": { "type": "boolean", "default": false }, "runtime": { "type": "boolean", "default": false }, "paramType": { "type": "integer" }, "mode": { "type": "integer" } }, "description": "Model containing the method level model for Interface ConfigInfo TargetParameterConfigInfo. to decode json data to internal NFM-P object model" } }, "children": { "type": "array", "items": { "type": "object", "required": [ "children", "objectClassName", "targetParam", "templateFdn" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "templateFdn": { "type": "string" }, "targetParam": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "parameterName": { "type": "string" }, "value": { "type": "string" }, "checkBoxValueDefined": { "type": "boolean", "default": false }, "unset": { "type": "boolean", "default": false }, "runtime": { "type": "boolean", "default": false }, "paramType": { "type": "integer" }, "mode": { "type": "integer" } }, "description": "Model containing the method level model for Interface ConfigInfo TargetParameterConfigInfo. to decode json data to internal NFM-P object model" } }, "children": { "type": "array", "items": { "type": "object" } } }, "description": "Model containing the method level model for struct MultiTemplateTargetParameterMap. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct MultiTemplateTargetParameterMap. to decode json data to internal NFM-P object model" } } ], "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": "/restScriptXmlApiConfigTemplateExecuteMulti" }, "task": true }, { "name": "restScriptXmlApiConfigTemplateGenerate", "summary": "generate", "description": "This method is used to generate a template. Depending on parameters specified by 'templateParams' the template can be generated from a class or an instance. Intention : MODIFIER generate: class-level modifier API generate of class script.XmlApiConfigTemplate The generated template.", "input": [ { "name": "body", "type": "object", "info": ": {\"templateConfiguration\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"mtosi_id\": 123, \"scriptName\": \"string\", \"mtosi_description\": \"string\", \"mtosi_type\": \"string\", \"scriptState\": 123, \"scriptMode\": 123, \"contentType\": 123, \"scriptType\": 123, \"useLatestVersion\": \"boolean\", \"autoSaveResult\": \"boolean\", \"reserveTargets\": \"boolean\", \"id\": 123, \"displayedName\": \"string\", \"description\": \"string\", \"bundleId\": 123, \"scopeOfCommandProfilePointer\": \"string\", \"configuredClass\": \"string\", \"configuredClassCategories\": \"string\", \"includeChildrenCreation\": \"boolean\", \"commandType\": 123, \"showCreatedObject\": \"boolean\"}, \"additionalParameters\": {\"objectClassName\": \"string\", \"parentTemplatePointer\": \"string\", \"generateBody\": \"boolean\", \"generateVelocityParameters\": \"boolean\", \"templatableObjectPointer\": \"string\", \"containmentLevel\": 123, \"includedVelocityParameters\": \"array\"}}", "required": false, "schema": { "type": "object", "required": [ "additionalParameters", "templateConfiguration" ], "properties": { "templateConfiguration": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "mtosi_id": { "type": "integer" }, "scriptName": { "type": "string" }, "mtosi_description": { "type": "string" }, "mtosi_type": { "type": "string" }, "scriptState": { "type": "integer" }, "scriptMode": { "type": "integer" }, "contentType": { "type": "integer" }, "scriptType": { "type": "integer" }, "useLatestVersion": { "type": "boolean", "default": false }, "autoSaveResult": { "type": "boolean", "default": false }, "reserveTargets": { "type": "boolean", "default": false }, "id": { "type": "integer" }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "bundleId": { "type": "integer" }, "scopeOfCommandProfilePointer": { "type": "string" }, "configuredClass": { "type": "string" }, "configuredClassCategories": { "type": "string" }, "includeChildrenCreation": { "type": "boolean", "default": false }, "commandType": { "type": "integer" }, "showCreatedObject": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface ConfigInfo XmlApiConfigTemplateConfigInfo. to decode json data to internal NFM-P object model" }, "additionalParameters": { "type": "object", "required": [ "containmentLevel", "generateBody", "generateVelocityParameters", "includedVelocityParameters", "objectClassName", "parentTemplatePointer", "templatableObjectPointer" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "parentTemplatePointer": { "type": "string" }, "generateBody": { "type": "boolean", "default": false }, "generateVelocityParameters": { "type": "boolean", "default": false }, "templatableObjectPointer": { "type": "string" }, "containmentLevel": { "type": "integer" }, "includedVelocityParameters": { "type": "array", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for struct XmlApiConfigTemplateParams. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for XmlApiConfigTemplate.generate to decode json data to internal NFM-P object model" } } ], "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": "/restScriptXmlApiConfigTemplateGenerate" }, "task": true }, { "name": "restScriptXmlApiConfigTemplateGenerateFromSample", "summary": "generateFromSample", "description": "This method is used to generate a template from a sample. Intention : MODIFIER generateFromSample: class-level modifier API generateFromSample of class script.XmlApiConfigTemplate The generated template.", "input": [ { "name": "body", "type": "object", "info": ": {\"templateConfiguration\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"mtosi_id\": 123, \"scriptName\": \"string\", \"mtosi_description\": \"string\", \"mtosi_type\": \"string\", \"scriptState\": 123, \"scriptMode\": 123, \"contentType\": 123, \"scriptType\": 123, \"useLatestVersion\": \"boolean\", \"autoSaveResult\": \"boolean\", \"reserveTargets\": \"boolean\", \"id\": 123, \"displayedName\": \"string\", \"description\": \"string\", \"bundleId\": 123, \"scopeOfCommandProfilePointer\": \"string\", \"configuredClass\": \"string\", \"configuredClassCategories\": \"string\", \"includeChildrenCreation\": \"boolean\", \"commandType\": 123, \"showCreatedObject\": \"boolean\"}, \"sampleId\": \"string\", \"parameters\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "parameters", "sampleId", "templateConfiguration" ], "properties": { "templateConfiguration": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "mtosi_id": { "type": "integer" }, "scriptName": { "type": "string" }, "mtosi_description": { "type": "string" }, "mtosi_type": { "type": "string" }, "scriptState": { "type": "integer" }, "scriptMode": { "type": "integer" }, "contentType": { "type": "integer" }, "scriptType": { "type": "integer" }, "useLatestVersion": { "type": "boolean", "default": false }, "autoSaveResult": { "type": "boolean", "default": false }, "reserveTargets": { "type": "boolean", "default": false }, "id": { "type": "integer" }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "bundleId": { "type": "integer" }, "scopeOfCommandProfilePointer": { "type": "string" }, "configuredClass": { "type": "string" }, "configuredClassCategories": { "type": "string" }, "includeChildrenCreation": { "type": "boolean", "default": false }, "commandType": { "type": "integer" }, "showCreatedObject": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface ConfigInfo XmlApiConfigTemplateConfigInfo. to decode json data to internal NFM-P object model" }, "sampleId": { "type": "string", "description": " The name of the sample." }, "parameters": { "type": "object", "description": " The parameters used to generate template from the sample.These parameters are optional and are specific to each sample.", "additionalProperties": { "type": "object" } } }, "description": "Model containing the method level model for XmlApiConfigTemplate.generateFromSample to decode json data to internal NFM-P object model" } } ], "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": "/restScriptXmlApiConfigTemplateGenerateFromSample" }, "task": true }, { "name": "restSecurityCpamLicenseClearRouterLimitExceedDueToMultiAdditions", "summary": "rest_security_CpamLicense_clearRouterLimitExceedDueToMultiAdditions", "description": "rest_security_CpamLicense_clearRouterLimitExceedDueToMultiAdditions", "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": "/restSecurityCpamLicenseClearRouterLimitExceedDueToMultiAdditions" }, "task": true }, { "name": "restSecuritySamJmsTopicManagerStopOssConnection", "summary": "rest_security_SamJmsTopicManager_stopOssConnection", "description": "rest_security_SamJmsTopicManager_stopOssConnection", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restSecuritySamJmsTopicManagerStopOssConnection" }, "task": true }, { "name": "restSecuritySamLicensePointsGetLicensePointsInventory", "summary": "getLicensePointsInventory", "description": "Returns license points consumption on each licensed object in a map of map with product id and site id as keys Intention : RETRIEVER getLicensePointsInventory: instance-level retriever API getLicensePointsInventory of class security.SamLicensePoints instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSecuritySamLicensePointsGetLicensePointsInventory" }, "task": true }, { "name": "restSecuritySpanMakeObjectsExplicit", "summary": "rest_security_Span_makeObjectsExplicit", "description": "rest_security_Span_makeObjectsExplicit", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restSecuritySpanMakeObjectsExplicit" }, "task": true }, { "name": "restSecuritySpanMakeObjectsImplicit", "summary": "rest_security_Span_makeObjectsImplicit", "description": "rest_security_Span_makeObjectsImplicit", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restSecuritySpanMakeObjectsImplicit" }, "task": true }, { "name": "restSecurityTSecurityManagerGetServerVersion", "summary": "getServerVersion", "description": "This method retrieves the NFM-P Server Version. Intention : RETRIEVER getServerVersion: class-level retriever API getServerVersion on default instance securityManager of class security.TSecurityManager", "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": "/restSecurityTSecurityManagerGetServerVersion" }, "task": true }, { "name": "restSecurityTSecurityManagerGetUXPrefs", "summary": "getUXPrefs", "description": "Retrieve UX specific configuration. Intention : RETRIEVER getUXPrefs: class-level retriever API getUXPrefs on default instance securityManager of class security.TSecurityManager The preferences.", "input": [ { "name": "prefName", "type": "string", "info": ": string", "required": false, "schema": { "title": "prefName", "type": "string" } }, { "name": "userName", "type": "string", "info": ": string", "required": false, "schema": { "title": "userName", "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": "/restSecurityTSecurityManagerGetUXPrefs" }, "task": true }, { "name": "restSecurityTSecurityManagerReAssignUser", "summary": "rest_security_TSecurityManager_reAssignUser", "description": "rest_security_TSecurityManager_reAssignUser", "input": [ { "name": "body", "type": "object", "info": ": {\"newUser\": \"string\", \"infoList\": [{\"objectClassName\": \"string\", \"objectFullName\": \"string\", \"allomorphicClassName\": \"string\", \"objectId\": 123, \"displayedName\": \"string\", \"lifeCycleState\": \"string\", \"deploymentState\": \"string\", \"neId\": \"string\", \"spanObjectPointer\": \"string\", \"parentClassName\": \"string\", \"managedObjectId\": 123, \"unsetProperties\": \"array\"}]}", "required": false, "schema": { "type": "object", "required": [ "infoList", "newUser" ], "properties": { "newUser": { "type": "string", "description": " " }, "infoList": { "type": "array", "description": " ", "items": { "type": "object", "required": [ "allomorphicClassName", "deploymentState", "displayedName", "lifeCycleState", "managedObjectId", "neId", "objectClassName", "objectFullName", "objectId", "parentClassName", "spanObjectPointer", "unsetProperties" ], "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer" }, "unsetProperties": { "type": "array", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for TSecurityManager.reAssignUser to decode json data to internal NFM-P object model" } } ], "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": "/restSecurityTSecurityManagerReAssignUser" }, "task": true }, { "name": "restSecurityTSecurityManagerRemoveUXPrefs", "summary": "rest_security_TSecurityManager_removeUXPrefs", "description": "rest_security_TSecurityManager_removeUXPrefs", "input": [ { "name": "body", "type": "object", "info": ": {\"prefName\": \"string\", \"userName\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "prefName", "userName" ], "properties": { "prefName": { "type": "string", "description": " The preference name." }, "userName": { "type": "string", "description": " The user name." } }, "description": "Model containing the method level model for TSecurityManager.removeUXPrefs to decode json data to internal NFM-P object model" } } ], "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": "/restSecurityTSecurityManagerRemoveUXPrefs" }, "task": true }, { "name": "restSecurityTSecurityManagerResumeUser", "summary": "rest_security_TSecurityManager_resumeUser", "description": "rest_security_TSecurityManager_resumeUser", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restSecurityTSecurityManagerResumeUser" }, "task": true }, { "name": "restSecurityTSecurityManagerSaveUXPrefs", "summary": "saveUXPrefs", "description": "Save UX based preferences. Intention : MODIFIER saveUXPrefs: class-level modifier API saveUXPrefs on default instance securityManager of class security.TSecurityManager The full name of the newly created preference.", "input": [ { "name": "body", "type": "object", "info": ": {\"prefName\": \"string\", \"contents\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "contents", "prefName" ], "properties": { "prefName": { "type": "string", "description": " The preference name." }, "contents": { "type": "string", "description": " The preferences." } }, "description": "Model containing the method level model for UserGroup.saveUXPrefs to decode json data to internal NFM-P object model" } } ], "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": "/restSecurityTSecurityManagerSaveUXPrefs" }, "task": true }, { "name": "restSecurityTSecurityManagerSuspendUser", "summary": "rest_security_TSecurityManager_suspendUser", "description": "rest_security_TSecurityManager_suspendUser", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restSecurityTSecurityManagerSuspendUser" }, "task": true }, { "name": "restSecurityUserGetUXPrefs", "summary": "getUXPrefs", "description": "Retrieve UX specific configuration. Intention : RETRIEVER getUXPrefs: instance-level retriever API getUXPrefs of class security.User instanceFullName : distinguished/instance name of called object The preferences.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "prefName", "type": "string", "info": ": string", "required": false, "schema": { "title": "prefName", "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": "/restSecurityUserGetUXPrefs" }, "task": true }, { "name": "restSecurityUserRemoveUXPrefs", "summary": "rest_security_User_removeUXPrefs", "description": "rest_security_User_removeUXPrefs", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restSecurityUserRemoveUXPrefs" }, "task": true }, { "name": "restSecurityUserSaveUXPrefs", "summary": "saveUXPrefs", "description": "Save UX based preferences. Intention : MODIFIER saveUXPrefs: instance-level modifier API saveUXPrefs of class security.User instanceFullName : distinguished/instance name of called object The full name of the newly created preference.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"prefName\": \"string\", \"contents\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "contents", "prefName" ], "properties": { "prefName": { "type": "string", "description": " The preference name." }, "contents": { "type": "string", "description": " The preferences." } }, "description": "Model containing the method level model for UserGroup.saveUXPrefs to decode json data to internal NFM-P object model" } } ], "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": "/restSecurityUserSaveUXPrefs" }, "task": true }, { "name": "restSecurityUserGroupGetUXPrefs", "summary": "getUXPrefs", "description": "Retrieve UX specific configuration. Intention : RETRIEVER getUXPrefs: instance-level retriever API getUXPrefs of class security.UserGroup instanceFullName : distinguished/instance name of called object The preferences.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "prefName", "type": "string", "info": ": string", "required": false, "schema": { "title": "prefName", "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": "/restSecurityUserGroupGetUXPrefs" }, "task": true }, { "name": "restSecurityUserGroupRemoveUXPrefs", "summary": "rest_security_UserGroup_removeUXPrefs", "description": "rest_security_UserGroup_removeUXPrefs", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restSecurityUserGroupRemoveUXPrefs" }, "task": true }, { "name": "restSecurityUserGroupSaveUXPrefs", "summary": "saveUXPrefs", "description": "Save UX based preferences. Intention : MODIFIER saveUXPrefs: instance-level modifier API saveUXPrefs of class security.UserGroup instanceFullName : distinguished/instance name of called object The full name of the newly created preference.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"prefName\": \"string\", \"contents\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "contents", "prefName" ], "properties": { "prefName": { "type": "string", "description": " The preference name." }, "contents": { "type": "string", "description": " The preferences." } }, "description": "Model containing the method level model for UserGroup.saveUXPrefs to decode json data to internal NFM-P object model" } } ], "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": "/restSecurityUserGroupSaveUXPrefs" }, "task": true }, { "name": "restSecuritypolicySecurityPolicyEntryDefinitionRenum", "summary": "rest_securitypolicy_SecurityPolicyEntryDefinition_renum", "description": "rest_securitypolicy_SecurityPolicyEntryDefinition_renum", "input": [ { "name": "body", "type": "object", "info": ": {\"aInNewEntryFullName\": \"string\", \"aInOldEntryFullName\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInNewEntryFullName": { "type": "string" }, "aInOldEntryFullName": { "type": "string" } }, "description": "Model containing the method level model for SecurityPolicyEntryDefinition.renum to decode json data to internal NFM-P object model" } } ], "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": "/restSecuritypolicySecurityPolicyEntryDefinitionRenum" }, "task": true }, { "name": "restSelfconfigPreProvisionedNeCreatePreProvNeFromTemplate", "summary": "createPreProvNeFromTemplate", "description": "Create a PreProvisioning NE based on a template Intention : MODIFIER createPreProvNeFromTemplate: class-level [administrative creation] (modifier) API createPreProvNeFromTemplate of class selfconfig.PreProvisionedNe Name of the generated WorkOrder file and SessionFdn of the created activation session if submitWOToActivationSession = true (else SessionFdn=\"\")", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"woFileName\": \"string\", \"submitWOToActivationSession\": \"boolean\", \"version\": \"string\", \"templateAndSpecificDataList\": [{\"objectClassName\": \"string\", \"templateName\": \"string\", \"templateRootId\": \"string\", \"parentXpath\": \"string\", \"updateServiceLink\": \"boolean\", \"specificDataList\": [{\"objectClassName\": \"string\", \"xpath\": \"string\", \"unset\": \"string\", \"simpleValue\": \"string\", \"listValue\": \"array\", \"indexedListValue\": [{\"objectClassName\": \"string\", \"index\": 123, \"value\": \"string\"}]}]}]}", "required": false, "schema": { "type": "object", "required": [ "objectClassName", "submitWOToActivationSession", "templateAndSpecificDataList", "version" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "woFileName": { "type": "string", "description": "Non documentable API" }, "submitWOToActivationSession": { "type": "boolean", "default": false }, "version": { "type": "string" }, "templateAndSpecificDataList": { "type": "array", "items": { "type": "object", "required": [ "objectClassName", "parentXpath", "specificDataList", "templateName", "templateRootId", "updateServiceLink" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "templateName": { "type": "string" }, "templateRootId": { "type": "string" }, "parentXpath": { "type": "string" }, "updateServiceLink": { "type": "boolean", "default": false }, "specificDataList": { "type": "array", "items": { "type": "object", "required": [ "indexedListValue", "listValue", "objectClassName", "simpleValue", "unset", "xpath" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "xpath": { "type": "string" }, "unset": { "type": "string" }, "simpleValue": { "type": "string" }, "listValue": { "type": "array", "items": { "type": "string" } }, "indexedListValue": { "type": "array", "items": { "type": "object", "required": [ "index", "objectClassName", "value" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "index": { "type": "integer" }, "value": { "type": "string" } }, "description": "Model containing the method level model for struct IndexedValue. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct SpecificData. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct TemplateAndSpecificData. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CreatePreProvNeParam. to decode json data to internal NFM-P object model" } } ], "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": "/restSelfconfigPreProvisionedNeCreatePreProvNeFromTemplate" }, "task": true }, { "name": "restSelfconfigPreProvisionedNeStateDeletePreProvNe", "summary": "rest_selfconfig_PreProvisionedNeState_deletePreProvNe", "description": "rest_selfconfig_PreProvisionedNeState_deletePreProvNe", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSelfconfigPreProvisionedNeStateDeletePreProvNe" }, "task": true }, { "name": "restSelfconfigPreProvisionedNeStateProceedToNextStage", "summary": "rest_selfconfig_PreProvisionedNeState_proceedToNextStage", "description": "rest_selfconfig_PreProvisionedNeState_proceedToNextStage", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSelfconfigPreProvisionedNeStateProceedToNextStage" }, "task": true }, { "name": "restSelfconfigPreProvisionedNeStateRetrySelfConfiguration", "summary": "rest_selfconfig_PreProvisionedNeState_retrySelfConfiguration", "description": "rest_selfconfig_PreProvisionedNeState_retrySelfConfiguration", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSelfconfigPreProvisionedNeStateRetrySelfConfiguration" }, "task": true }, { "name": "restServerAuxServerPairAssignedObjects", "summary": "rest_server_AuxServerPair_assignedObjects", "description": "rest_server_AuxServerPair_assignedObjects", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restServerAuxServerPairAssignedObjects" }, "task": true }, { "name": "restServerAuxServerPairUnAssignedObjects", "summary": "rest_server_AuxServerPair_unAssignedObjects", "description": "rest_server_AuxServerPair_unAssignedObjects", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restServerAuxServerPairUnAssignedObjects" }, "task": true }, { "name": "restServerTCEDeleteAllENBs", "summary": "deleteAllENBs", "description": "Unassign to TCE all eNBs which are in a suitable state and have not an active trace. If forceDelete is true, unassign all eNBs unconditionally. Intention : MODIFIER deleteAllENBs: instance-level [administrative deletion] (modifier) API deleteAllENBs of class server.TCE instanceFullName : distinguished/instance name of called object The number of un-deleted eNBs because of active traces or unsuitable state.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restServerTCEDeleteAllENBs" }, "task": true }, { "name": "restServerTCEPreDeleteENBs", "summary": "preDeleteENBs", "description": "Identify which eNBs will be - and will not be - removed from a TCE Intention : MODIFIER preDeleteENBs: instance-level modifier API preDeleteENBs of class server.TCE instanceFullName : distinguished/instance name of called object The number of un-deleted eNBs because of active traces or unsuitable state.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"configInfo\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}, \"forceDelete\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "configInfo", "forceDelete" ], "properties": { "configInfo": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" }, "forceDelete": { "type": "boolean", "description": " To force eNB unassignment from TCE.", "default": false } }, "description": "Model containing the method level model for TCE.preDeleteENBs to decode json data to internal NFM-P object model" } } ], "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": "/restServerTCEPreDeleteENBs" }, "task": true }, { "name": "restServiceAaInterfaceShutDown", "summary": "rest_service_AaInterface_shutDown", "description": "rest_service_AaInterface_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restServiceAaInterfaceShutDown" }, "task": true }, { "name": "restServiceAaInterfaceTurnUp", "summary": "rest_service_AaInterface_turnUp", "description": "rest_service_AaInterface_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restServiceAaInterfaceTurnUp" }, "task": true }, { "name": "restServiceAccessInterfaceFindSitesFor", "summary": "findSitesFor", "description": "Find the sites used by the access interfaces identified by the filter. Intention : RETRIEVER findSitesFor: class-level [object finder] (retriever) API findSitesFor of class service.AccessInterface DescendantInfo: vpls.AbstractPbbSap DescendantInfo: ipipe.L2AccessInterface DescendantInfo: ies.L3AccessInterface DescendantInfo: mvpls.IL2AccessInterface DescendantInfo: service.AaInterface DescendantInfo: vpls.IL2AccessInterface DescendantInfo: vlan.L2AccessInterface DescendantInf...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"expandChildren\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "expandChildren", "filter" ], "properties": { "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "expandChildren": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for VirtualRouterIpAddress.findSitesFor to decode json data to internal NFM-P object model" } } ], "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": "/restServiceAccessInterfaceFindSitesFor" }, "task": true }, { "name": "restServiceAccessInterfaceMoveSapToAnotherService", "summary": "moveSapToAnotherService", "description": "Move the sap from this service to another service. Only L2 AccessInterfaces are supported for now. Input the SAP FDN and the destination site FDN Intention : MODIFIER moveSapToAnotherService: class-level modifier API moveSapToAnotherService of class service.AccessInterface DescendantInfo: vpls.AbstractPbbSap DescendantInfo: ipipe.L2AccessInterface DescendantInfo: ies.L3AccessInterface DescendantInfo: mvpls.IL2AccessInterface DescendantInfo: service.AaInterface DescendantInfo: vp...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"sourceSapFdn\": \"string\", \"destSiteFdn\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "destSiteFdn", "sourceSapFdn" ], "properties": { "sourceSapFdn": { "type": "string", "description": " " }, "destSiteFdn": { "type": "string", "description": " " } }, "description": "Model containing the method level model for AccessInterface.moveSapToAnotherService to decode json data to internal NFM-P object model" } } ], "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": "/restServiceAccessInterfaceMoveSapToAnotherService" }, "task": true }, { "name": "restServiceCompositeServiceAddServices", "summary": "rest_service_CompositeService_addServices", "description": "rest_service_CompositeService_addServices", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restServiceCompositeServiceAddServices" }, "task": true }, { "name": "restServiceCompositeServiceCreateCrossConnect", "summary": "createCrossConnect", "description": "Intention : MODIFIER createCrossConnect: instance-level [administrative creation] (modifier) API createCrossConnect of class service.CompositeService instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"displayedName\": \"string\", \"description\": \"string\", \"firstSvcPointer\": \"string\", \"secondSvcPointer\": \"string\", \"firstSitePointer\": \"string\", \"secondSitePointer\": \"string\", \"ccagPointer\": \"string\", \"ccId\": 123, \"firstAccessInterfacePointer\": \"string\", \"secondAccessInterfacePointer\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "firstSvcPointer": { "type": "string" }, "secondSvcPointer": { "type": "string" }, "firstSitePointer": { "type": "string" }, "secondSitePointer": { "type": "string" }, "ccagPointer": { "type": "string" }, "ccId": { "type": "integer" }, "firstAccessInterfacePointer": { "type": "string" }, "secondAccessInterfacePointer": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo CrossConnectConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restServiceCompositeServiceCreateCrossConnect" }, "task": true }, { "name": "restServiceCompositeServiceCreateRoutedVplsConnector", "summary": "createRoutedVplsConnector", "description": "Intention : MODIFIER createRoutedVplsConnector: instance-level [administrative creation] (modifier) API createRoutedVplsConnector of class service.CompositeService instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"displayedName\": \"string\", \"description\": \"string\", \"firstSvcPointer\": \"string\", \"secondSvcPointer\": \"string\", \"firstSitePointer\": \"string\", \"secondSitePointer\": \"string\", \"accessInterfacePointer\": \"string\", \"vplsSitePointer\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "firstSvcPointer": { "type": "string" }, "secondSvcPointer": { "type": "string" }, "firstSitePointer": { "type": "string" }, "secondSitePointer": { "type": "string" }, "accessInterfacePointer": { "type": "string" }, "vplsSitePointer": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo RoutedVplsConnectorConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restServiceCompositeServiceCreateRoutedVplsConnector" }, "task": true }, { "name": "restServiceCompositeServiceCreateScpConnector", "summary": "createScpConnector", "description": "Intention : MODIFIER createScpConnector: instance-level [administrative creation] (modifier) API createScpConnector of class service.CompositeService instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"displayedName\": \"string\", \"description\": \"string\", \"firstSvcPointer\": \"string\", \"secondSvcPointer\": \"string\", \"firstSitePointer\": \"string\", \"secondSitePointer\": \"string\", \"scpConnectorId\": 123, \"firstScpPointer\": \"string\", \"secondScpPointer\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "firstSvcPointer": { "type": "string" }, "secondSvcPointer": { "type": "string" }, "firstSitePointer": { "type": "string" }, "secondSitePointer": { "type": "string" }, "scpConnectorId": { "type": "integer" }, "firstScpPointer": { "type": "string" }, "secondScpPointer": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo ScpConnectorConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restServiceCompositeServiceCreateScpConnector" }, "task": true }, { "name": "restServiceCompositeServiceCreateService", "summary": "createService", "description": "creates a service and it add the service to this CompositeService Intention : MODIFIER createService: instance-level [administrative creation] (modifier) API createService of class service.CompositeService instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"id\": 123, \"displayedName\": \"string\", \"description\": \"string\", \"serviceId\": 123, \"templatePointer\": \"string\", \"subscriberPointer\": \"string\", \"groupPointer\": \"string\", \"administrativeState\": 123, \"tier\": 123, \"globalServiceName\": \"string\", \"globalServiceComments\": \"string\", \"svcPriority\": 123, \"enableAppPerfReporting\": \"boolean\", \"ipDetailCount\": 123, \"reportCustName\": \"string\", \"nsdManaged\": \"boolean\", \"lockOlcState\": \"boolean\", \"templateVersionPointer\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "id": { "type": "integer" }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "serviceId": { "type": "integer" }, "templatePointer": { "type": "string" }, "subscriberPointer": { "type": "string" }, "groupPointer": { "type": "string" }, "administrativeState": { "type": "integer" }, "tier": { "type": "integer" }, "globalServiceName": { "type": "string" }, "globalServiceComments": { "type": "string" }, "svcPriority": { "type": "integer" }, "enableAppPerfReporting": { "type": "boolean", "default": false }, "ipDetailCount": { "type": "integer" }, "reportCustName": { "type": "string" }, "nsdManaged": { "type": "boolean", "default": false }, "lockOlcState": { "type": "boolean", "default": false }, "templateVersionPointer": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo ServiceConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restServiceCompositeServiceCreateService" }, "task": true }, { "name": "restServiceCompositeServiceCreateSpokeConnector", "summary": "createSpokeConnector", "description": "Intention : MODIFIER createSpokeConnector: instance-level [administrative creation] (modifier) API createSpokeConnector of class service.CompositeService instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"displayedName\": \"string\", \"description\": \"string\", \"firstSvcPointer\": \"string\", \"secondSvcPointer\": \"string\", \"firstSitePointer\": \"string\", \"secondSitePointer\": \"string\", \"vcId\": 123, \"autoSelectTunnel\": \"boolean\", \"tunnelSelectionProfile\": \"string\", \"transportPreference\": 123, \"firstTunnelPointer\": \"string\", \"firstL3AccessInterfacePointer\": \"string\", \"secondL3AccessInterfacePointer\": \"string\", \"secondTunnelPointer\": \"string\", \"firstSdpBindingPointer\": \"string\", \"secondSdpBindingPointer\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "firstSvcPointer": { "type": "string" }, "secondSvcPointer": { "type": "string" }, "firstSitePointer": { "type": "string" }, "secondSitePointer": { "type": "string" }, "vcId": { "type": "integer" }, "autoSelectTunnel": { "type": "boolean", "default": false }, "tunnelSelectionProfile": { "type": "string" }, "transportPreference": { "type": "integer" }, "firstTunnelPointer": { "type": "string" }, "firstL3AccessInterfacePointer": { "type": "string" }, "secondL3AccessInterfacePointer": { "type": "string" }, "secondTunnelPointer": { "type": "string" }, "firstSdpBindingPointer": { "type": "string" }, "secondSdpBindingPointer": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo SpokeConnectorConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restServiceCompositeServiceCreateSpokeConnector" }, "task": true }, { "name": "restServiceCompositeServiceGetConnectors", "summary": "getConnectors", "description": "Returns all connectors of this composite service. Intention : RETRIEVER getConnectors: instance-level retriever API getConnectors of class service.CompositeService instanceFullName : distinguished/instance name of called object Connectors of this composite service. The returned connector objects are shallow (they do not contain any child objects).", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restServiceCompositeServiceGetConnectors" }, "task": true }, { "name": "restServiceCompositeServiceGetServiceSites", "summary": "getServiceSites", "description": "Returns all service sites of this composite service. Intention : RETRIEVER getServiceSites: instance-level retriever API getServiceSites of class service.CompositeService instanceFullName : distinguished/instance name of called object Service sites of this composite service. The returned site objects are shallow (they do not contain any child objects).", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restServiceCompositeServiceGetServiceSites" }, "task": true }, { "name": "restServiceCompositeServiceGetServices", "summary": "getServices", "description": "Returns all services of this composite service. Intention : RETRIEVER getServices: instance-level retriever API getServices of class service.CompositeService instanceFullName : distinguished/instance name of called object Services of this composite service. The returned service objects are shallow (they do not contain any child objects).", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restServiceCompositeServiceGetServices" }, "task": true }, { "name": "restServiceCompositeServiceMoveServices", "summary": "rest_service_CompositeService_moveServices", "description": "rest_service_CompositeService_moveServices", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInDestCompositeService\": \"string\", \"aInFdns\": \"array\"}", "required": false, "schema": { "type": "object", "properties": { "aInDestCompositeService": { "type": "string" }, "aInFdns": { "type": "array", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for CompositeService.moveServices to decode json data to internal NFM-P object model" } } ], "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": "/restServiceCompositeServiceMoveServices" }, "task": true }, { "name": "restServiceCompositeServicePrepareThroughputTest", "summary": "prepareThroughputTest", "description": "Prepare the throughput test with the test info passed in. Intention : MODIFIER prepareThroughputTest: class-level modifier API prepareThroughputTest of class service.CompositeService A list of error messages.", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"srcSapBeingReplaced\": \"string\", \"srcPortForTesting\": \"string\", \"dstSapBeingReplaced\": \"string\", \"dstPortForTesting\": \"string\", \"dstPortLoopback\": 123, \"dstPortLoopbackTime\": 123, \"loopbackSwapMacAddr\": \"boolean\", \"loopbackPersist\": \"boolean\", \"loopbackSapPointer\": \"string\", \"loopbackDstMacAddress\": \"string\", \"loopbackSrcMacAddress\": \"string\", \"srcSdpBindingPointer\": \"string\", \"testServiceId\": 123}", "required": false, "schema": { "type": "object", "required": [ "dstPortForTesting", "dstPortLoopback", "dstPortLoopbackTime", "dstSapBeingReplaced", "loopbackDstMacAddress", "loopbackPersist", "loopbackSapPointer", "loopbackSrcMacAddress", "loopbackSwapMacAddr", "objectClassName", "srcPortForTesting", "srcSapBeingReplaced", "srcSdpBindingPointer", "testServiceId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "srcSapBeingReplaced": { "type": "string" }, "srcPortForTesting": { "type": "string" }, "dstSapBeingReplaced": { "type": "string" }, "dstPortForTesting": { "type": "string" }, "dstPortLoopback": { "type": "integer" }, "dstPortLoopbackTime": { "type": "integer" }, "loopbackSwapMacAddr": { "type": "boolean", "default": false }, "loopbackPersist": { "type": "boolean", "default": false }, "loopbackSapPointer": { "type": "string" }, "loopbackDstMacAddress": { "type": "string" }, "loopbackSrcMacAddress": { "type": "string" }, "srcSdpBindingPointer": { "type": "string" }, "testServiceId": { "type": "integer" } }, "description": "Model containing the method level model for struct ThroughputTestStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restServiceCompositeServicePrepareThroughputTest" }, "task": true }, { "name": "restServiceCompositeServiceRemoveServices", "summary": "rest_service_CompositeService_removeServices", "description": "rest_service_CompositeService_removeServices", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restServiceCompositeServiceRemoveServices" }, "task": true }, { "name": "restServiceCompositeServiceRestoreCompSvcForThroughputTest", "summary": "restoreCompSvcForThroughputTest", "description": "Restore the composite service from the throughput test. Intention : MODIFIER restoreCompSvcForThroughputTest: class-level modifier API restoreCompSvcForThroughputTest of class service.CompositeService A list of error messages.", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restServiceCompositeServiceRestoreCompSvcForThroughputTest" }, "task": true }, { "name": "restServiceGroupInterfaceCleanUpBondingGroupInterface", "summary": "rest_service_GroupInterface_cleanUpBondingGroupInterface", "description": "rest_service_GroupInterface_cleanUpBondingGroupInterface", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restServiceGroupInterfaceCleanUpBondingGroupInterface" }, "task": true }, { "name": "restServiceGroupInterfaceCleanUpGtpGroupInterface", "summary": "rest_service_GroupInterface_cleanUpGtpGroupInterface", "description": "rest_service_GroupInterface_cleanUpGtpGroupInterface", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restServiceGroupInterfaceCleanUpGtpGroupInterface" }, "task": true }, { "name": "restServiceIPsecInterfaceRequestPolicyAccountStatsClear", "summary": "requestPolicyAccountStatsClear", "description": "Request clearing of Policy Accounting Statistics on this interface. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestPolicyAccountStatsClear: instance-level modifier API requestPolicyAccountStatsClear of class service.IPsecInterface DescendantInfo: ies...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInAcctType\": 123, \"aInAcctIndex\": 123, \"aInClearAll\": \"boolean\"}", "required": false, "schema": { "type": "object", "properties": { "aInAcctType": { "type": "integer" }, "aInAcctIndex": { "type": "integer" }, "aInClearAll": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for NetworkInterface.requestPolicyAccountStatsClear to decode json data to internal NFM-P object model" } } ], "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": "/restServiceIPsecInterfaceRequestPolicyAccountStatsClear" }, "task": true }, { "name": "restServiceIPsecInterfaceShutDown", "summary": "rest_service_IPsecInterface_shutDown", "description": "rest_service_IPsecInterface_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restServiceIPsecInterfaceShutDown" }, "task": true }, { "name": "restServiceIPsecInterfaceTurnUp", "summary": "rest_service_IPsecInterface_turnUp", "description": "rest_service_IPsecInterface_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restServiceIPsecInterfaceTurnUp" }, "task": true }, { "name": "restServiceL2AccessInterfaceCleanupSAPsWithBadFdns", "summary": "rest_service_L2AccessInterface_cleanupSAPsWithBadFdns", "description": "rest_service_L2AccessInterface_cleanupSAPsWithBadFdns", "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": "/restServiceL2AccessInterfaceCleanupSAPsWithBadFdns" }, "task": true }, { "name": "restServiceL2AccessInterfaceCopyMoveSaps", "summary": "copyMoveSaps", "description": "Copy or move the SAPs from the source port to destination port with a source SAP filter. Only Epipe, Ipipe, (B,I)VPLS and (B,I)MVPLS type of L2 SAPs, and IES, VPRN type of L3 SAPs(L3 Access Interface, L3 Service Access Point) on source port will be copied or moved. Intention : MODIFIER copyMoveSaps: class-level modifier API copyMoveSaps of class service.L2AccessInterface DescendantInfo: vpls.AbstractPbbSap DescendantInfo: vpls.L2AccessInterface DescendantInfo: ipipe.L2AccessInterface ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"copyMoveStruct\": {\"objectClassName\": \"string\", \"sourcePortFdn\": \"string\", \"destinationPortFdn\": \"string\", \"isMoving\": \"boolean\", \"outerEncapShiftOffset\": 123, \"innerEncapShiftOffset\": 123, \"targetType\": 123}, \"sourceSapFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "copyMoveStruct", "sourceSapFilter" ], "properties": { "copyMoveStruct": { "type": "object", "required": [ "destinationPortFdn", "innerEncapShiftOffset", "isMoving", "objectClassName", "outerEncapShiftOffset", "sourcePortFdn", "targetType" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "sourcePortFdn": { "type": "string" }, "destinationPortFdn": { "type": "string" }, "isMoving": { "type": "boolean", "default": false }, "outerEncapShiftOffset": { "type": "integer" }, "innerEncapShiftOffset": { "type": "integer" }, "targetType": { "type": "integer" } }, "description": "Model containing the method level model for struct SapCopyMoveStruct. to decode json data to internal NFM-P object model" }, "sourceSapFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for L2AccessInterface.copyMoveSaps to decode json data to internal NFM-P object model" } } ], "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": "/restServiceL2AccessInterfaceCopyMoveSaps" }, "task": true }, { "name": "restServiceL2AccessInterfaceCopyMoveSapsWithSapList", "summary": "copyMoveSapsWithSapList", "description": "Copy or move the SAPs with passed in source SAP fullName list. Executing this method on the destination port instance. Only Epipe, Ipipe, (B,I)VPLS and (B,I)MVPLS type of L2 SAPs, and IES, VPRN type of L3 SAPs(L3 Access Interface, L3 Service Access Point) can be copied or moved. Intention : MODIFIER copyMoveSapsWithSapList: class-level modifier API copyMoveSapsWithSapList of class service.L2AccessInterface DescendantInfo: vpls.AbstractPbbSap DescendantInfo: vpls.L2AccessInterface Desce...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"sapList\": \"array\", \"destinationPortFdn\": \"string\", \"outerEncapShiftOffset\": 123, \"innerEncapShiftOffset\": 123, \"isMoving\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "destinationPortFdn", "innerEncapShiftOffset", "isMoving", "outerEncapShiftOffset", "sapList" ], "properties": { "sapList": { "type": "array", "description": " ", "items": { "type": "string" } }, "destinationPortFdn": { "type": "string", "description": " " }, "outerEncapShiftOffset": { "type": "integer", "description": " " }, "innerEncapShiftOffset": { "type": "integer", "description": " " }, "isMoving": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for L2AccessInterface.copyMoveSapsWithSapList to decode json data to internal NFM-P object model" } } ], "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": "/restServiceL2AccessInterfaceCopyMoveSapsWithSapList" }, "task": true }, { "name": "restServiceL2AccessInterfaceFindMcRingProtectedSaps", "summary": "findMcRingProtectedSaps", "description": "Return the list of the Multi Chassis Ring protected L2 Access Interface on the ethernet port or LAG. This method will return all the SAPs managed by MC ring(s) if there are multiples rings on this port. The ring should be in administrative up state. Intention : RETRIEVER findMcRingProtectedSaps: class-level [object finder] (retriever) API findMcRingProtectedSaps of class service.L2AccessInterface DescendantInfo: vpls.AbstractPbbSap DescendantInfo: vpls.L2AccessInterface DescendantInfo:...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"portFdn\": \"string\", \"sapFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "portFdn", "sapFilter" ], "properties": { "portFdn": { "type": "string", "description": " " }, "sapFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for L2AccessInterface.findMcRingProtectedSaps to decode json data to internal NFM-P object model" } } ], "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": "/restServiceL2AccessInterfaceFindMcRingProtectedSaps" }, "task": true }, { "name": "restServiceL2AccessInterfaceFindMcRingProtectedSapsOnRing", "summary": "findMcRingProtectedSapsOnRing", "description": "Return the list of the Multi Chassis Ring protected L2 Access Interface on the ring. The ring should be in administrative up state. Intention : RETRIEVER findMcRingProtectedSapsOnRing: class-level [object finder] (retriever) API findMcRingProtectedSapsOnRing of class service.L2AccessInterface DescendantInfo: vpls.AbstractPbbSap DescendantInfo: vpls.L2AccessInterface DescendantInfo: ipipe.L2AccessInterface DescendantInfo: mvpls.IL2AccessInterface DescendantInfo: vpls.AbstractL2Acce...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"ringFdn\": \"string\", \"sapFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "ringFdn", "sapFilter" ], "properties": { "ringFdn": { "type": "string", "description": " " }, "sapFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for L2AccessInterface.findMcRingProtectedSapsOnRing to decode json data to internal NFM-P object model" } } ], "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": "/restServiceL2AccessInterfaceFindMcRingProtectedSapsOnRing" }, "task": true }, { "name": "restServiceL3AccessInterfaceRemoveIpAddress", "summary": "removeIpAddress", "description": "Intention : MODIFIER removeIpAddress: instance-level [administrative deletion] (modifier) API removeIpAddress of class service.L3AccessInterface DescendantInfo: ies.L3AccessInterface DescendantInfo: vprn.L3AccessInterface instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restServiceL3AccessInterfaceRemoveIpAddress" }, "task": true }, { "name": "restServiceL3AccessInterfaceShutDown", "summary": "rest_service_L3AccessInterface_shutDown", "description": "rest_service_L3AccessInterface_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restServiceL3AccessInterfaceShutDown" }, "task": true }, { "name": "restServiceL3AccessInterfaceTurnUp", "summary": "rest_service_L3AccessInterface_turnUp", "description": "rest_service_L3AccessInterface_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restServiceL3AccessInterfaceTurnUp" }, "task": true }, { "name": "restServiceMacPingCancelMacPingTest", "summary": "rest_service_MacPing_cancelMacPingTest", "description": "rest_service_MacPing_cancelMacPingTest", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restServiceMacPingCancelMacPingTest" }, "task": true }, { "name": "restServiceSapLagPerLinkHashCleanupOrphanedInstance", "summary": "rest_service_SapLagPerLinkHash_cleanupOrphanedInstance", "description": "rest_service_SapLagPerLinkHash_cleanupOrphanedInstance", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restServiceSapLagPerLinkHashCleanupOrphanedInstance" }, "task": true }, { "name": "restServiceScpConnectorGetTransitService", "summary": "getTransitService", "description": "Return the Transit Service which is associated with this Scp Connector. Intention : RETRIEVER getTransitService: instance-level retriever API getTransitService of class service.ScpConnector instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restServiceScpConnectorGetTransitService" }, "task": true }, { "name": "restServiceServiceDeleteAllSystemDCPGroups", "summary": "rest_service_Service_DeleteAllSystemDCPGroups", "description": "rest_service_Service_DeleteAllSystemDCPGroups", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restServiceServiceDeleteAllSystemDCPGroups" }, "task": true }, { "name": "restServiceServiceAuditServiceState", "summary": "rest_service_Service_auditServiceState", "description": "rest_service_Service_auditServiceState", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } } ], "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": "/restServiceServiceAuditServiceState" }, "task": true }, { "name": "restServiceServiceGetServiceSegments", "summary": "getServiceSegments", "description": "Returns all service segments of this service. Intention : RETRIEVER getServiceSegments: instance-level retriever API getServiceSegments of class service.Service DescendantInfo: hpipe.Hpipe DescendantInfo: mpr.BackhaulService DescendantInfo: pbbvlan.VlanPBBEdge DescendantInfo: vlan.Vlan DescendantInfo: fpipe.Fpipe DescendantInfo: mvpls.Mvpls DescendantInfo: optical.TransportService DescendantInfo: optical.MultipointTransportService DescendantInfo: apipe.Apipe DescendantInf...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restServiceServiceGetServiceSegments" }, "task": true }, { "name": "restServiceServiceRediscoverReturnSpokeSdpBinding", "summary": "rest_service_Service_rediscoverReturnSpokeSdpBinding", "description": "rest_service_Service_rediscoverReturnSpokeSdpBinding", "input": [ { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restServiceServiceRediscoverReturnSpokeSdpBinding" }, "task": true }, { "name": "restServiceServiceShutDown", "summary": "rest_service_Service_shutDown", "description": "rest_service_Service_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restServiceServiceShutDown" }, "task": true }, { "name": "restServiceServiceTurnUp", "summary": "rest_service_Service_turnUp", "description": "rest_service_Service_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restServiceServiceTurnUp" }, "task": true }, { "name": "restServiceServiceManagerIgnoreSAPPortState", "summary": "rest_service_ServiceManager_IgnoreSAPPortState", "description": "rest_service_ServiceManager_IgnoreSAPPortState", "input": [ { "name": "body", "type": "object", "info": ": {\"ObjectName\": \"string\", \"action\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "action" ], "properties": { "ObjectName": { "type": "string" }, "action": { "type": "string", "description": " Optional filter." } }, "description": "Model containing the method level model for ServiceManager.IgnoreSAPPortState to decode json data to internal NFM-P object model" } } ], "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": "/restServiceServiceManagerIgnoreSAPPortState" }, "task": true }, { "name": "restServiceServiceManagerNavigateToOppositeObj", "summary": "NavigateToOppositeObj", "description": "The other SAP for the VLAN Up-Link. Intention : RETRIEVER NavigateToOppositeObj: instance-level retriever API NavigateToOppositeObj on default instance svc-mgr of class service.ServiceManager", "input": [ { "name": "body", "type": "object", "info": ": {\"ObjectName\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter" ], "properties": { "ObjectName": { "type": "string" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for ServiceManager.NavigateToOppositeObj to decode json data to internal NFM-P object model" } } ], "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": "/restServiceServiceManagerNavigateToOppositeObj" }, "task": true }, { "name": "restServiceSiteFindSitesFor", "summary": "findSitesFor", "description": "Find the sites identified by the filter. Intention : RETRIEVER findSitesFor: class-level [object finder] (retriever) API findSitesFor of class service.Site DescendantInfo: dctr.VprnVirtualSite DescendantInfo: vpls.BSite DescendantInfo: ies.Site DescendantInfo: mvpls.EvpnSite DescendantInfo: apipe.Site DescendantInfo: vpls.EvpnSite DescendantInfo: epipe.AbstractSite DescendantInfo: mvpls.Site DescendantInfo: mpr.BackhaulSite DescendantInfo: vpls.AbstractSite DescendantIn...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"expandChildren\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "expandChildren", "filter" ], "properties": { "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "expandChildren": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for VirtualRouterIpAddress.findSitesFor to decode json data to internal NFM-P object model" } } ], "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": "/restServiceSiteFindSitesFor" }, "task": true }, { "name": "restServiceSiteShutDown", "summary": "rest_service_Site_shutDown", "description": "rest_service_Site_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restServiceSiteShutDown" }, "task": true }, { "name": "restServiceSiteTurnUp", "summary": "rest_service_Site_turnUp", "description": "rest_service_Site_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restServiceSiteTurnUp" }, "task": true }, { "name": "restServiceSvcActTestHeadAcceptanceCriteriaTemplateFindTests", "summary": "findTests", "description": "Intention : RETRIEVER findTests: instance-level [object finder] (retriever) API findTests of class service.SvcActTestHeadAcceptanceCriteriaTemplate instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restServiceSvcActTestHeadAcceptanceCriteriaTemplateFindTests" }, "task": true }, { "name": "restServiceSvcActTestHeadFrameSizeTemplateFindTests", "summary": "findTests", "description": "Intention : RETRIEVER findTests: instance-level [object finder] (retriever) API findTests of class service.SvcActTestHeadFrameSizeTemplate instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restServiceSvcActTestHeadFrameSizeTemplateFindTests" }, "task": true }, { "name": "restServiceSvcResourceReservationRetrieveReservedResources", "summary": "retrieveReservedResources", "description": "Performs the retrieval of reserved resources such as route targets for specific service. Intention : RETRIEVER retrieveReservedResources: class-level retriever API retrieveReservedResources of class service.SvcResourceReservation", "input": [ { "name": "body", "type": "object", "info": ": {\"anInClassName\": \"string\", \"anInfilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "anInClassName", "anInfilter" ], "properties": { "anInClassName": { "type": "string", "description": " The class name which can be service.SvcResourceReservation or service.ReservedRouteTarget" }, "anInfilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for SvcResourceReservation.retrieveReservedResources to decode json data to internal NFM-P object model" } } ], "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": "/restServiceSvcResourceReservationRetrieveReservedResources" }, "task": true }, { "name": "restServiceSvcTopologyCompleteSvcTopology", "summary": "rest_service_SvcTopology_completeSvcTopology", "description": "rest_service_SvcTopology_completeSvcTopology", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restServiceSvcTopologyCompleteSvcTopology" }, "task": true }, { "name": "restServiceTemplateServiceConstructServiceTemplate", "summary": "constructServiceTemplate", "description": "Given a service, this method constructs the corresponding service template Intention : MODIFIER constructServiceTemplate: class-level modifier API constructServiceTemplate of class service.TemplateService DescendantInfo: fpipe.TemplateFpipe DescendantInfo: vprn.TemplateVprn DescendantInfo: mvpls.TemplateMvpls DescendantInfo: cpipe.TemplateCpipe DescendantInfo: ies.TemplateIes DescendantInfo: vll.TemplateVll DescendantInfo: ipipe.TemplateIpipe DescendantInfo: apipe.TemplateAp...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"aInServiceFdn\": \"string\", \"aInSetSubscriber\": \"boolean\"}", "required": false, "schema": { "type": "object", "properties": { "aInServiceFdn": { "type": "string" }, "aInSetSubscriber": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for TemplateService.constructServiceTemplate to decode json data to internal NFM-P object model" } } ], "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": "/restServiceTemplateServiceConstructServiceTemplate" }, "task": true }, { "name": "restServiceTemplateServiceConstructTemplatedService", "summary": "constructTemplatedService", "description": "This method is a specialized form of constructing a templated object from a template, applicable to templated service creation only. It returns a list containing the service subscriber being created, as well as the template driving the creation and any associated templates that were used for creation (eg. service template has template bindings that refer to real templates that are used for templated service creation). Intention : MODIFIER constructTemplatedService: instance-level modifier AP...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restServiceTemplateServiceConstructTemplatedService" }, "task": true }, { "name": "restServiceVlanUplinkGetTransitService", "summary": "getTransitService", "description": "Return the Transit Service which is associated with this VLAN Uplink. Intention : RETRIEVER getTransitService: instance-level retriever API getTransitService of class service.VlanUplink instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restServiceVlanUplinkGetTransitService" }, "task": true }, { "name": "restServiceY1564AcceptanceCriteriaProfileFindTests", "summary": "findTests", "description": "Intention : RETRIEVER findTests: instance-level [object finder] (retriever) API findTests of class service.Y1564AcceptanceCriteriaProfile instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restServiceY1564AcceptanceCriteriaProfileFindTests" }, "task": true }, { "name": "restServiceY1564FrameMixProfileFindTests", "summary": "findTests", "description": "Intention : RETRIEVER findTests: instance-level [object finder] (retriever) API findTests of class service.Y1564FrameMixProfile instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restServiceY1564FrameMixProfileFindTests" }, "task": true }, { "name": "restServiceY1564PayloadProfileFindTests", "summary": "findTests", "description": "Intention : RETRIEVER findTests: instance-level [object finder] (retriever) API findTests of class service.Y1564PayloadProfile instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restServiceY1564PayloadProfileFindTests" }, "task": true }, { "name": "restServiceY1564TestStopTest", "summary": "rest_service_Y1564Test_stopTest", "description": "rest_service_Y1564Test_stopTest", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restServiceY1564TestStopTest" }, "task": true }, { "name": "restServiceY1564TestHeadProfileClearTestResults", "summary": "clearTestResults", "description": "Intention : MODIFIER clearTestResults: instance-level [functionality clearing] (modifier) API clearTestResults of class service.Y1564TestHeadProfile instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restServiceY1564TestHeadProfileClearTestResults" }, "task": true }, { "name": "restServiceY1564TestHeadProfileFindTests", "summary": "findTests", "description": "Intention : RETRIEVER findTests: instance-level [object finder] (retriever) API findTests of class service.Y1564TestHeadProfile instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restServiceY1564TestHeadProfileFindTests" }, "task": true }, { "name": "restShgPortConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class shg.Port This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restShgPortConfigure" }, "task": true }, { "name": "restShgPortFind", "summary": "find", "description": "Intention : RETRIEVER find: instance-level [object finder] (retriever) API find of class shg.Port instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restShgPortFind" }, "task": true }, { "name": "restShgSiteConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class shg.Site This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restShgSiteConfigure" }, "task": true }, { "name": "restSimulatorActionEventFindServices", "summary": "findServices", "description": "Find all the associated Services with a path monitor. Intention : RETRIEVER findServices: instance-level [object finder] (retriever) API findServices of class simulator.ActionEvent instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectType\": 123, \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "fields", "filter", "objectType", "pageNumber", "pageSize", "sortFields" ], "properties": { "objectType": { "type": "integer", "description": " " }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "fields": { "type": "array", "description": " Sorting fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for IpPathRecord.findServices to decode json data to internal NFM-P object model" } } ], "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": "/restSimulatorActionEventFindServices" }, "task": true }, { "name": "restSimulatorScenarioAnalyzeImpact", "summary": "rest_simulator_Scenario_analyzeImpact", "description": "rest_simulator_Scenario_analyzeImpact", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSimulatorScenarioAnalyzeImpact" }, "task": true }, { "name": "restSimulatorScenarioClose", "summary": "rest_simulator_Scenario_close", "description": "rest_simulator_Scenario_close", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSimulatorScenarioClose" }, "task": true }, { "name": "restSimulatorScenarioOpen", "summary": "rest_simulator_Scenario_open", "description": "rest_simulator_Scenario_open", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSimulatorScenarioOpen" }, "task": true }, { "name": "restSimulatorScenarioOpenAndImport", "summary": "rest_simulator_Scenario_openAndImport", "description": "rest_simulator_Scenario_openAndImport", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"importFrom\": \"string\", \"importPaths\": \"array\", \"igpProtocols\": \"array\", \"isIsLevel\": \"string\", \"objectPtr\": \"string\", \"fromMonitoredIps\": \"array\", \"fromLsps\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "fromLsps", "fromMonitoredIps", "igpProtocols", "importFrom", "importPaths", "isIsLevel", "objectClassName", "objectPtr" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "importFrom": { "type": "string" }, "importPaths": { "type": "array", "items": { "type": "string" } }, "igpProtocols": { "type": "array", "items": { "type": "string" } }, "isIsLevel": { "type": "string" }, "objectPtr": { "type": "string" }, "fromMonitoredIps": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "fromLsps": { "type": "array", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for struct ImportStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restSimulatorScenarioOpenAndImport" }, "task": true }, { "name": "restSitesecCpmFilterQueueRequestClearCpmFilterQueue", "summary": "requestClearCpmFilterQueue", "description": "Request clearing of CPM Filter Queue using this local policy. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearCpmFilterQueue: instance-level modifier API requestClearCpmFilterQueue of class sitesec.CpmFilterQueue instanceFullName : distinguished/i...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSitesecCpmFilterQueueRequestClearCpmFilterQueue" }, "task": true }, { "name": "restSitesecCpmIpFilterEntryBaseRenum", "summary": "rest_sitesec_CpmIpFilterEntryBase_renum", "description": "rest_sitesec_CpmIpFilterEntryBase_renum", "input": [ { "name": "body", "type": "object", "info": ": {\"aInNewEntryFullName\": \"string\", \"aInOldEntryFullName\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInNewEntryFullName": { "type": "string" }, "aInOldEntryFullName": { "type": "string" } }, "description": "Model containing the method level model for SecurityPolicyEntryDefinition.renum to decode json data to internal NFM-P object model" } } ], "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": "/restSitesecCpmIpFilterEntryBaseRenum" }, "task": true }, { "name": "restSitesecCpmIpFilterEntryBaseRequestClearCpmIpFilter", "summary": "requestClearCpmIpFilter", "description": "Request clearing of CPM IP Filter using this local policy. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearCpmIpFilter: instance-level modifier API requestClearCpmIpFilter of class sitesec.CpmIpFilterEntryBase DescendantInfo: sitesec.CpmIpFilterE...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restSitesecCpmIpFilterEntryBaseRequestClearCpmIpFilter" }, "task": true }, { "name": "restSitesecCpmMacFilterEntryRenum", "summary": "rest_sitesec_CpmMacFilterEntry_renum", "description": "rest_sitesec_CpmMacFilterEntry_renum", "input": [ { "name": "body", "type": "object", "info": ": {\"aInNewEntryFullName\": \"string\", \"aInOldEntryFullName\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInNewEntryFullName": { "type": "string" }, "aInOldEntryFullName": { "type": "string" } }, "description": "Model containing the method level model for SecurityPolicyEntryDefinition.renum to decode json data to internal NFM-P object model" } } ], "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": "/restSitesecCpmMacFilterEntryRenum" }, "task": true }, { "name": "restSitesecCpmMacFilterEntryRequestClearCpmMacFilter", "summary": "requestClearCpmMacFilter", "description": "Request clearing of CPM MAC Filter using this local policy. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearCpmMacFilter: instance-level modifier API requestClearCpmMacFilter of class sitesec.CpmMacFilterEntry instanceFullName : distinguished/inst...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restSitesecCpmMacFilterEntryRequestClearCpmMacFilter" }, "task": true }, { "name": "restSitesecLocalUserClearPasswordHistory", "summary": "rest_sitesec_LocalUser_clearPasswordHistory", "description": "rest_sitesec_LocalUser_clearPasswordHistory", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restSitesecLocalUserClearPasswordHistory" }, "task": true }, { "name": "restSitesecLocalUserUnlockUser", "summary": "rest_sitesec_LocalUser_unlockUser", "description": "rest_sitesec_LocalUser_unlockUser", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restSitesecLocalUserUnlockUser" }, "task": true }, { "name": "restSitesecMacMafEntryRenum", "summary": "rest_sitesec_MacMafEntry_renum", "description": "rest_sitesec_MacMafEntry_renum", "input": [ { "name": "body", "type": "object", "info": ": {\"aInNewEntryFullName\": \"string\", \"aInOldEntryFullName\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInNewEntryFullName": { "type": "string" }, "aInOldEntryFullName": { "type": "string" } }, "description": "Model containing the method level model for SecurityPolicyEntryDefinition.renum to decode json data to internal NFM-P object model" } } ], "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": "/restSitesecMacMafEntryRenum" }, "task": true }, { "name": "restSitesecMafEntryBaseRenum", "summary": "rest_sitesec_MafEntryBase_renum", "description": "rest_sitesec_MafEntryBase_renum", "input": [ { "name": "body", "type": "object", "info": ": {\"aInNewEntryFullName\": \"string\", \"aInOldEntryFullName\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInNewEntryFullName": { "type": "string" }, "aInOldEntryFullName": { "type": "string" } }, "description": "Model containing the method level model for SecurityPolicyEntryDefinition.renum to decode json data to internal NFM-P object model" } } ], "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": "/restSitesecMafEntryBaseRenum" }, "task": true }, { "name": "restSitesecSiteSystemSecurityConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class sitesec.SiteSystemSecurity This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restSitesecSiteSystemSecurityConfigure" }, "task": true }, { "name": "restSitesecUserProfileEntryRenum", "summary": "rest_sitesec_UserProfileEntry_renum", "description": "rest_sitesec_UserProfileEntry_renum", "input": [ { "name": "body", "type": "object", "info": ": {\"aInNewEntryFullName\": \"string\", \"aInOldEntryFullName\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInNewEntryFullName": { "type": "string" }, "aInOldEntryFullName": { "type": "string" } }, "description": "Model containing the method level model for SecurityPolicyEntryDefinition.renum to decode json data to internal NFM-P object model" } } ], "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": "/restSitesecUserProfileEntryRenum" }, "task": true }, { "name": "restSlopeQosPoolConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class slope.QosPool This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"shelfId\": 123, \"equipmentPointer\": \"string\", \"equipmentType\": 123, \"appType\": 123, \"appPool\": \"string\", \"slopePolicyPointer\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "shelfId": { "type": "integer" }, "equipmentPointer": { "type": "string" }, "equipmentType": { "type": "integer" }, "appType": { "type": "integer" }, "appPool": { "type": "string" }, "slopePolicyPointer": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo QosPoolConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restSlopeQosPoolConfigure" }, "task": true }, { "name": "restSnmpPollerManagerFindPolicy", "summary": "findPolicy", "description": "finds the list of poller policies for a particular product and version Intention : RETRIEVER findPolicy: instance-level [object finder] (retriever) API findPolicy on default instance pollerManager of class snmp.PollerManager list of policies", "input": [ { "name": "productId", "type": "number", "info": ": 123", "required": false, "schema": { "title": "productId", "type": "number" } }, { "name": "versionId", "type": "number", "info": ": 123", "required": false, "schema": { "title": "versionId", "type": "number" } } ], "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": "/restSnmpPollerManagerFindPolicy" }, "task": true }, { "name": "restSnmpPollerManagerGetPollerManager", "summary": "getPollerManager", "description": "retrieves the default instance of the poller manager Intention : RETRIEVER getPollerManager: instance-level retriever API getPollerManager on default instance pollerManager of class snmp.PollerManager returns the poller manager instance", "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": "/restSnmpPollerManagerGetPollerManager" }, "task": true }, { "name": "restSnmpPollerManagerGetStatsMibEntryPolicy", "summary": "getStatsMibEntryPolicy", "description": "retrieves stats mib entry policy associated to the object Intention : RETRIEVER getStatsMibEntryPolicy: instance-level retriever API getStatsMibEntryPolicy on default instance pollerManager of class snmp.PollerManager returns the stats mib entry policy", "input": [ { "name": "aInFullName", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInFullName", "type": "string" } }, { "name": "aInStatsClassName", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInStatsClassName", "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": "/restSnmpPollerManagerGetStatsMibEntryPolicy" }, "task": true }, { "name": "restSnmpPollerManagerGetStatsMibPolicy", "summary": "getStatsMibPolicy", "description": "retrieves stats entry policy associated to the object Intention : RETRIEVER getStatsMibPolicy: instance-level retriever API getStatsMibPolicy on default instance pollerManager of class snmp.PollerManager list of the policies", "input": [ { "name": "aInFullName", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInFullName", "type": "string" } }, { "name": "aInStatsClassName", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInStatsClassName", "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": "/restSnmpPollerManagerGetStatsMibPolicy" }, "task": true }, { "name": "restSnmpPollerManagerResync", "summary": "rest_snmp_PollerManager_resync", "description": "rest_snmp_PollerManager_resync", "input": [ { "name": "body", "type": "object", "info": ": {\"neIdOrNameList\": \"array\", \"mibOidList\": \"array\", \"ignoreTimestamps\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "ignoreTimestamps", "mibOidList", "neIdOrNameList" ], "properties": { "neIdOrNameList": { "type": "array", "description": " list of network elements to be resynched", "items": { "type": "string" } }, "mibOidList": { "type": "array", "description": " list of the mibs to be resynched", "items": { "type": "string" } }, "ignoreTimestamps": { "type": "boolean", "description": " ignore time stamps", "default": false } }, "description": "Model containing the method level model for PollerManager.resync to decode json data to internal NFM-P object model" } } ], "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": "/restSnmpPollerManagerResync" }, "task": true }, { "name": "restSnmpPollerPolicyConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class snmp.PollerPolicy This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"pollingInterval\": 123, \"productId\": 123, \"versionId\": 123, \"mibEntityOid\": \"string\", \"administrativeState\": 123, \"numberOfVarPerPdu\": 123, \"useBulkRequest\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "pollingInterval": { "type": "integer" }, "productId": { "type": "integer" }, "versionId": { "type": "integer" }, "mibEntityOid": { "type": "string" }, "administrativeState": { "type": "integer" }, "numberOfVarPerPdu": { "type": "integer" }, "useBulkRequest": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface ConfigInfo PollerPolicyConfigInfo. to decode json data to internal NFM-P object model" } } ], "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": "/restSnmpPollerPolicyConfigure" }, "task": true }, { "name": "restSnmpSpecificStatsPollerPolicyAddMonitoredObjects", "summary": "rest_snmp_SpecificStatsPollerPolicy_addMonitoredObjects", "description": "rest_snmp_SpecificStatsPollerPolicy_addMonitoredObjects", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restSnmpSpecificStatsPollerPolicyAddMonitoredObjects" }, "task": true }, { "name": "restSnmpSpecificStatsPollerPolicyRemoveMonitoredObjects", "summary": "rest_snmp_SpecificStatsPollerPolicy_removeMonitoredObjects", "description": "rest_snmp_SpecificStatsPollerPolicy_removeMonitoredObjects", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restSnmpSpecificStatsPollerPolicyRemoveMonitoredObjects" }, "task": true }, { "name": "restSnmpStatsPollerPolicyFindNEs", "summary": "findNEs", "description": "Find all the NEs with the specified MIB statistics polling policy assigned. Intention : RETRIEVER findNEs: class-level [object finder] (retriever) API findNEs of class snmp.StatsPollerPolicy", "input": [ { "name": "policyId", "type": "number", "info": ": 123", "required": false, "schema": { "title": "policyId", "type": "number" } } ], "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": "/restSnmpStatsPollerPolicyFindNEs" }, "task": true }, { "name": "restSonetPtpPortRecoveredClockHistoryRetrievePtpPortRecoveredClockHistory", "summary": "retrievePtpPortRecoveredClockHistory", "description": "Method used to query the NE for the recovered clock history of a particular PTPPort. Intention : RETRIEVER retrievePtpPortRecoveredClockHistory: class-level retriever API retrievePtpPortRecoveredClockHistory of class sonet.PtpPortRecoveredClockHistory DescendantInfo: sonet.PtpPortRecoveredClockHistoryMasterTwo DescendantInfo: sonet.PtpPortRecoveredClockHistoryMasterOne", "input": [ { "name": "body", "type": "object", "info": ": {\"aInPtpPortName\": \"string\", \"aInMasterIndex\": 123, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInPtpPortName": { "type": "string" }, "aInMasterIndex": { "type": "integer" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns." } }, "description": "Model containing the method level model for PtpPortRecoveredClockHistory.retrievePtpPortRecoveredClockHistory to decode json data to internal NFM-P object model" } } ], "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": "/restSonetPtpPortRecoveredClockHistoryRetrievePtpPortRecoveredClockHistory" }, "task": true }, { "name": "restSonetSiteSyncFindSyncTimeLinks", "summary": "findSyncTimeLinks", "description": "Intention : RETRIEVER findSyncTimeLinks: class-level [object finder] (retriever) API findSyncTimeLinks of class sonet.SiteSync", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restSonetSiteSyncFindSyncTimeLinks" }, "task": true }, { "name": "restSonetSiteSyncFindSyncTimeSources", "summary": "findSyncTimeSources", "description": "Intention : RETRIEVER findSyncTimeSources: class-level [object finder] (retriever) API findSyncTimeSources of class sonet.SiteSync", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for SiteSync.findSyncTimeSources to decode json data to internal NFM-P object model" } } ], "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": "/restSonetSiteSyncFindSyncTimeSources" }, "task": true }, { "name": "restSonetSiteSyncRetrieveQualityTiming", "summary": "retrieveQualityTiming", "description": "Intention : RETRIEVER retrieveQualityTiming: class-level retriever API retrieveQualityTiming of class sonet.SiteSync Map that holds the fdn of the network element this SiteSync is on and its state (i.e. if either it should categorized as Red Yellow Green)", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restSonetSiteSyncRetrieveQualityTiming" }, "task": true }, { "name": "restSonetequipmentSonetPortSpecificsFindChannels", "summary": "findChannels", "description": "Intention : RETRIEVER findChannels: instance-level [object finder] (retriever) API findChannels of class sonetequipment.SonetPortSpecifics instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restSonetequipmentSonetPortSpecificsFindChannels" }, "task": true }, { "name": "restSpanrulesServiceCreationSpanRuleFindAssociatedSamUserGroups", "summary": "findAssociatedSamUserGroups", "description": "Finds all user groups that are assigned to the format or range policies under this span rule. Intention : RETRIEVER findAssociatedSamUserGroups: instance-level [object finder] (retriever) API findAssociatedSamUserGroups of class spanrules.ServiceCreationSpanRule instanceFullName : distinguished/instance name of called object List of object summaries", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restSpanrulesServiceCreationSpanRuleFindAssociatedSamUserGroups" }, "task": true }, { "name": "restSpanrulesServiceCreationSpanRuleFindAssociatedSamUsers", "summary": "findAssociatedSamUsers", "description": "Finds all users that are assigned to the format or range policies under this span rule. Intention : RETRIEVER findAssociatedSamUsers: instance-level [object finder] (retriever) API findAssociatedSamUsers of class spanrules.ServiceCreationSpanRule instanceFullName : distinguished/instance name of called object List of object summaries", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restSpanrulesServiceCreationSpanRuleFindAssociatedSamUsers" }, "task": true }, { "name": "restSpbAccessInterfaceFindFateSharedInterfaces", "summary": "findFateSharedInterfaces", "description": "Performs retrieval of all fated shared user SAP interfaces for SPB control service. Intention : RETRIEVER findFateSharedInterfaces: class-level [object finder] (retriever) API findFateSharedInterfaces of class spb.AccessInterface", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInserviceId\": 123, \"aInInterfaceDN\": \"string\", \"anInfilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "anInfilter", "fields", "pageNumber", "pageSize", "sortFields" ], "properties": { "aInSiteId": { "type": "string" }, "aInserviceId": { "type": "integer" }, "aInInterfaceDN": { "type": "string" }, "anInfilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "fields": { "type": "array", "description": " Fields to fetch", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for SpokeSdpBindingInterface.findFateSharedInterfaces to decode json data to internal NFM-P object model" } } ], "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": "/restSpbAccessInterfaceFindFateSharedInterfaces" }, "task": true }, { "name": "restSpbAccessStaticIsidRetrieveStaticIsids", "summary": "retrieveStaticIsids", "description": "Method used to query the NE for SPB Static ISIDs associated with SAPs of the service. Intention : RETRIEVER retrieveStaticIsids: class-level retriever API retrieveStaticIsids of class spb.AccessStaticIsid", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInInterfaceDN\": \"string\", \"aInFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"aInSvcId\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInInterfaceDN": { "type": "string" }, "aInFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "aInSvcId": { "type": "integer" } }, "description": "Model containing the method level model for SpokeSdpBindingStaticIsid.retrieveStaticIsids to decode json data to internal NFM-P object model" } } ], "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": "/restSpbAccessStaticIsidRetrieveStaticIsids" }, "task": true }, { "name": "restSpbSpokeSdpBindingInterfaceFindFateSharedInterfaces", "summary": "findFateSharedInterfaces", "description": "Performs retrieval of all fated shared user Spoke SDP Binding interfaces for SPB control service. Intention : RETRIEVER findFateSharedInterfaces: class-level [object finder] (retriever) API findFateSharedInterfaces of class spb.SpokeSdpBindingInterface", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInserviceId\": 123, \"aInInterfaceDN\": \"string\", \"anInfilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "anInfilter", "fields", "pageNumber", "pageSize", "sortFields" ], "properties": { "aInSiteId": { "type": "string" }, "aInserviceId": { "type": "integer" }, "aInInterfaceDN": { "type": "string" }, "anInfilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "fields": { "type": "array", "description": " Fields to fetch", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for SpokeSdpBindingInterface.findFateSharedInterfaces to decode json data to internal NFM-P object model" } } ], "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": "/restSpbSpokeSdpBindingInterfaceFindFateSharedInterfaces" }, "task": true }, { "name": "restSpbSpokeSdpBindingStaticIsidRetrieveStaticIsids", "summary": "retrieveStaticIsids", "description": "Method used to query the NE for SPB Static ISIDs associated with Spoke SDP Bindings of the service. Intention : RETRIEVER retrieveStaticIsids: class-level retriever API retrieveStaticIsids of class spb.SpokeSdpBindingStaticIsid", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInInterfaceDN\": \"string\", \"aInFilter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"aInSvcId\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInInterfaceDN": { "type": "string" }, "aInFilter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "aInSvcId": { "type": "integer" } }, "description": "Model containing the method level model for SpokeSdpBindingStaticIsid.retrieveStaticIsids to decode json data to internal NFM-P object model" } } ], "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": "/restSpbSpokeSdpBindingStaticIsidRetrieveStaticIsids" }, "task": true }, { "name": "restSqueuePolicyFindAccessInterfaces", "summary": "findAccessInterfaces", "description": "Intention : RETRIEVER findAccessInterfaces: instance-level [object finder] (retriever) API findAccessInterfaces of class squeue.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSqueuePolicyFindAccessInterfaces" }, "task": true }, { "name": "restSqueuePolicyFindServiceAccessPoints", "summary": "findServiceAccessPoints", "description": "Intention : RETRIEVER findServiceAccessPoints: instance-level [object finder] (retriever) API findServiceAccessPoints of class squeue.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSqueuePolicyFindServiceAccessPoints" }, "task": true }, { "name": "restSqueuePolicyFindServiceInterfaces", "summary": "findServiceInterfaces", "description": "Intention : RETRIEVER findServiceInterfaces: instance-level [object finder] (retriever) API findServiceInterfaces of class squeue.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSqueuePolicyFindServiceInterfaces" }, "task": true }, { "name": "restSrmrmtauthRemoteAuthServerConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class srmrmtauth.RemoteAuthServer This API follows hierarchical config model rules. DescendantInfo: srmrmtauth.TacacsPlusAuthServer DescendantInfo: srmrmtauth.RadiusAuthServer DescendantInfo: srmrmtauth.LdapAuthServer instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restSrmrmtauthRemoteAuthServerConfigure" }, "task": true }, { "name": "restSrmrmtauthRemoteAuthenticationManagerConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure on default instance remote-authentication-manager of class srmrmtauth.RemoteAuthenticationManager This API follows hierarchical config model rules.", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restSrmrmtauthRemoteAuthenticationManagerConfigure" }, "task": true }, { "name": "restSrpythonmgmtPythonScriptReloadUrl", "summary": "rest_srpythonmgmt_PythonScript_reloadUrl", "description": "rest_srpythonmgmt_PythonScript_reloadUrl", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restSrpythonmgmtPythonScriptReloadUrl" }, "task": true }, { "name": "restStatisticsSamPerformanceStatsConfigure", "summary": "configure", "description": "This method is used to modify a NFM-P performance statistic. Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class statistics.SamPerformanceStats This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object Object full name of NFM-P performance statistic that is modified.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restStatisticsSamPerformanceStatsConfigure" }, "task": true }, { "name": "restStatisticsSamPerformanceStatsManagerCollect", "summary": "rest_statistics_SamPerformanceStatsManager_collect", "description": "rest_statistics_SamPerformanceStatsManager_collect", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restStatisticsSamPerformanceStatsManagerCollect" }, "task": true }, { "name": "restStatisticsSamPerformanceStatsManagerConfigure", "summary": "configure", "description": "This method is used to configure a NFM-P performance statistic. Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure on default instance samPerformanceStatsManager of class statistics.SamPerformanceStatsManager This API follows hierarchical config model rules. An object full name of the NFM-P statistic instance (configured).", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restStatisticsSamPerformanceStatsManagerConfigure" }, "task": true }, { "name": "restSubscrSubscriberPopulateTo", "summary": "populateTo", "description": "Populates the subscriber site with the site IP Address Intention : MODIFIER populateTo: instance-level modifier API populateTo of class subscr.Subscriber instanceFullName : distinguished/instance name of called object Set of subscriber site's full-names which were populated.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restSubscrSubscriberPopulateTo" }, "task": true }, { "name": "restSubscrauthPolicyGetServiceDependencyCount", "summary": "getServiceDependencyCount", "description": "Intention : RETRIEVER getServiceDependencyCount: instance-level retriever API getServiceDependencyCount of class subscrauth.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSubscrauthPolicyGetServiceDependencyCount" }, "task": true }, { "name": "restSupSummaryViewAddGroups", "summary": "addGroups", "description": "This method adds a set of supervision groups to this summary view. Intention : MODIFIER addGroups: instance-level modifier API addGroups of class sup.SummaryView instanceFullName : distinguished/instance name of called object Set of all supervision group FDNs in this summary view.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restSupSummaryViewAddGroups" }, "task": true }, { "name": "restSupSummaryViewGetAlarms", "summary": "getAlarms", "description": "This method returns alarms on all failed objects in the supervision group in this summary view. Intention : RETRIEVER getAlarms: instance-level retriever API getAlarms of class sup.SummaryView instanceFullName : distinguished/instance name of called object Map of alarms. The alarm full name is the map key.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "supervisionGroupName", "type": "string", "info": ": string", "required": false, "schema": { "title": "supervisionGroupName", "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": "/restSupSummaryViewGetAlarms" }, "task": true }, { "name": "restSupSummaryViewGetAlarmsWithFilter", "summary": "getAlarmsWithFilter", "description": "This method returns alarms on all failed objects in the supervision group in this summary view. Intention : RETRIEVER getAlarmsWithFilter: instance-level retriever API getAlarmsWithFilter of class sup.SummaryView instanceFullName : distinguished/instance name of called object Map of alarms. The alarm full name is the map key.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"supervisionGroupName\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter", "supervisionGroupName" ], "properties": { "supervisionGroupName": { "type": "string", "description": " Supervision Group name." }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for SummaryView.getAlarmsWithFilter to decode json data to internal NFM-P object model" } } ], "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": "/restSupSummaryViewGetAlarmsWithFilter" }, "task": true }, { "name": "restSupSummaryViewGetCachedHistory", "summary": "getCachedHistory", "description": "This method returns the accumulated history of one or all supervision groups for this summary view. Intention : RETRIEVER getCachedHistory: instance-level retriever API getCachedHistory of class sup.SummaryView instanceFullName : distinguished/instance name of called object A map keyed by group name of GroupState time ordered snapshots of supervision group state history.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"supervisionGroupName\": \"string\", \"startTime\": 123}", "required": false, "schema": { "type": "object", "required": [ "startTime", "supervisionGroupName" ], "properties": { "supervisionGroupName": { "type": "string", "description": " Supervision Group name.If null, the history of all supervision groupsin the summary view is returned." }, "startTime": { "type": "integer", "description": " If not null, return history of monitoredgroup(s) starting at or after that time." } }, "description": "Model containing the method level model for SummaryView.getCachedHistory to decode json data to internal NFM-P object model" } } ], "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": "/restSupSummaryViewGetCachedHistory" }, "task": true }, { "name": "restSupSummaryViewGetMonitoredObjectsByClasses", "summary": "getMonitoredObjectsByClasses", "description": "This method returns all objects of specified classes in the supervision group in this summary view. Intention : RETRIEVER getMonitoredObjectsByClasses: instance-level retriever API getMonitoredObjectsByClasses of class sup.SummaryView instanceFullName : distinguished/instance name of called object Info info structures of monitored objects in the group matching 'classes' parameter. class.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"supervisionGroupName\": \"string\", \"classes\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "classes", "supervisionGroupName" ], "properties": { "supervisionGroupName": { "type": "string", "description": " Supervision Group name." }, "classes": { "type": "array", "description": " Classes of objects in this group to fetch.If null or empty, get all monitored objects inthe group.", "uniqueItems": true, "items": { "type": "string" } } }, "description": "Model containing the method level model for SummaryView.getMonitoredObjectsByClasses to decode json data to internal NFM-P object model" } } ], "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": "/restSupSummaryViewGetMonitoredObjectsByClasses" }, "task": true }, { "name": "restSupSummaryViewGetMonitoredObjectsSummaries", "summary": "getMonitoredObjectsSummaries", "description": "This method returns states of all or failed objects in the supervision group in this summary view. Intention : RETRIEVER getMonitoredObjectsSummaries: instance-level retriever API getMonitoredObjectsSummaries of class sup.SummaryView instanceFullName : distinguished/instance name of called object Set of all monitored object FDNs in this summary view.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"supervisionGroupName\": \"string\", \"getProblemObjectsOnly\": \"boolean\", \"startTime\": 123}", "required": false, "schema": { "type": "object", "required": [ "getProblemObjectsOnly", "startTime", "supervisionGroupName" ], "properties": { "supervisionGroupName": { "type": "string", "description": " Supervision Group name." }, "getProblemObjectsOnly": { "type": "boolean", "description": " If true, the method will return only objectswith non-zero KPIs (e.g. alarms, failed etc.)", "default": false }, "startTime": { "type": "integer", "description": " Get counts of alarms and failed tests on themonitored objects since this time." } }, "description": "Model containing the method level model for SummaryView.getMonitoredObjectsSummaries to decode json data to internal NFM-P object model" } } ], "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": "/restSupSummaryViewGetMonitoredObjectsSummaries" }, "task": true }, { "name": "restSupSummaryViewGetNeTraceStatusObjectsByGroup", "summary": "getNeTraceStatusObjectsByGroup", "description": "This method returns all NeTraceStatus objects in the supervision group in this summary view. Intention : RETRIEVER getNeTraceStatusObjectsByGroup: instance-level retriever API getNeTraceStatusObjectsByGroup of class sup.SummaryView instanceFullName : distinguished/instance name of called object Info info structures of NeTraceStatus objects in the group. class.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "supervisionGroupName", "type": "string", "info": ": string", "required": false, "schema": { "title": "supervisionGroupName", "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": "/restSupSummaryViewGetNeTraceStatusObjectsByGroup" }, "task": true }, { "name": "restSupSummaryViewGetNumFailedCells", "summary": "getNumFailedCells", "description": "This method returns the number of failed cells returns -1 if not enodeB. Intention : RETRIEVER getNumFailedCells: instance-level retriever API getNumFailedCells of class sup.SummaryView instanceFullName : distinguished/instance name of called object Info info structures of monitored objects in the group matching 'classes' parameter. class.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "supervisionParentFDN", "type": "string", "info": ": string", "required": false, "schema": { "title": "supervisionParentFDN", "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": "/restSupSummaryViewGetNumFailedCells" }, "task": true }, { "name": "restSupSummaryViewListGroups", "summary": "listGroups", "description": "This method returns the list of supervision groups in this summary view. Intention : RETRIEVER listGroups: instance-level retriever API listGroups of class sup.SummaryView instanceFullName : distinguished/instance name of called object Set of all supervision group FDNs in this summary view.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSupSummaryViewListGroups" }, "task": true }, { "name": "restSupSummaryViewRemoveGroups", "summary": "removeGroups", "description": "This method removes a set of supervision groups from this summary view. Intention : MODIFIER removeGroups: instance-level [administrative deletion] (modifier) API removeGroups of class sup.SummaryView instanceFullName : distinguished/instance name of called object Set of all supervision group FDNs in this summary view.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restSupSummaryViewRemoveGroups" }, "task": true }, { "name": "restSupSummaryViewSetBaseline", "summary": "setBaseline", "description": "This method sets baseline (current moment in time) for all future monitored \"*New*\" KPI events - e.g. new alarms raised, new tests failures etc.. Intention : MODIFIER setBaseline: instance-level modifier API setBaseline of class sup.SummaryView instanceFullName : distinguished/instance name of called object The time of setting the baseline.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSupSummaryViewSetBaseline" }, "task": true }, { "name": "restSupSummaryViewSetGroupBaseline", "summary": "setGroupBaseline", "description": "This method sets baseline (current moment in time) for the specified supervision group for all future monitored \"*New*\" KPI events - e.g. new alarms raised, new tests failures etc.. Intention : MODIFIER setGroupBaseline: instance-level modifier API setGroupBaseline of class sup.SummaryView instanceFullName : distinguished/instance name of called object The time of setting the baseline.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restSupSummaryViewSetGroupBaseline" }, "task": true }, { "name": "restSupSupervisionGroupAddInclusionFilter", "summary": "addInclusionFilter", "description": "This method adds a filter for monitored objects to this supervision group. Filtered objects' class can't be the class of subclass used by any other inclusion filter in this group. Intention : MODIFIER addInclusionFilter: instance-level modifier API addInclusionFilter of class sup.SupervisionGroup instanceFullName : distinguished/instance name of called object New value of the \"inclusionFilters\" property - FDNs of all inclusion filters in this group.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restSupSupervisionGroupAddInclusionFilter" }, "task": true }, { "name": "restSupSupervisionGroupAddTriggerFilter", "summary": "addTriggerFilter", "description": "This method adds a filter for monitoring trigger objects to this supervision group. Intention : MODIFIER addTriggerFilter: instance-level modifier API addTriggerFilter of class sup.SupervisionGroup instanceFullName : distinguished/instance name of called object Set of all trigger filter FDNS in this supervision group. Filtered objects' class can't be the class of subclass used by any other trigger filter in this group.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restSupSupervisionGroupAddTriggerFilter" }, "task": true }, { "name": "restSupSupervisionGroupGetHistoryBuffer", "summary": "getHistoryBuffer", "description": "This method returns the accumulated history of one or all supervision groups for this summary view. Intention : RETRIEVER getHistoryBuffer: instance-level retriever API getHistoryBuffer of class sup.SupervisionGroup instanceFullName : distinguished/instance name of called object Time ordered snapshots of supervision group states.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"supervisionGroupName\": \"string\", \"startTime\": 123}", "required": false, "schema": { "type": "object", "required": [ "startTime", "supervisionGroupName" ], "properties": { "supervisionGroupName": { "type": "string", "description": " If null, the history of all supervision groupsin the summary view is returned." }, "startTime": { "type": "integer", "description": " If not null, return history of all monitoredgroups starting in the specified time." } }, "description": "Model containing the method level model for SupervisionGroup.getHistoryBuffer to decode json data to internal NFM-P object model" } } ], "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": "/restSupSupervisionGroupGetHistoryBuffer" }, "task": true }, { "name": "restSupSupervisionGroupGetInfoWithMonitoredObjects", "summary": "getInfoWithMonitoredObjects", "description": "This method returns the info structure for this group with the set of monitored objects filled in. Intention : RETRIEVER getInfoWithMonitoredObjects: instance-level retriever API getInfoWithMonitoredObjects of class sup.SupervisionGroup instanceFullName : distinguished/instance name of called object Time ordered snapshots of supervision group states.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSupSupervisionGroupGetInfoWithMonitoredObjects" }, "task": true }, { "name": "restSupSupervisionGroupListSummaryViews", "summary": "listSummaryViews", "description": "This method returns the set of summary views that include this supervision group. Intention : RETRIEVER listSummaryViews: instance-level retriever API listSummaryViews of class sup.SupervisionGroup instanceFullName : distinguished/instance name of called object Set of all summary view FDNs that include this supervision group.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSupSupervisionGroupListSummaryViews" }, "task": true }, { "name": "restSupSupervisionGroupRemoveInclusionFilter", "summary": "removeInclusionFilter", "description": "This method removes a filter for monitored objects from this supervision group. Intention : MODIFIER removeInclusionFilter: instance-level [administrative deletion] (modifier) API removeInclusionFilter of class sup.SupervisionGroup instanceFullName : distinguished/instance name of called object New value of the \"inclusionFilters\" property - FDNs of all inclusion filters in this group.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restSupSupervisionGroupRemoveInclusionFilter" }, "task": true }, { "name": "restSupSupervisionGroupRemoveTriggerFilter", "summary": "removeTriggerFilter", "description": "This method removes a filter for monitoring trigger objects from this supervision group. Intention : MODIFIER removeTriggerFilter: instance-level [administrative deletion] (modifier) API removeTriggerFilter of class sup.SupervisionGroup instanceFullName : distinguished/instance name of called object Set of all trigger filter FDNS in this supervision group.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restSupSupervisionGroupRemoveTriggerFilter" }, "task": true }, { "name": "restSupSupervisionGroupSetBaseline", "summary": "setBaseline", "description": "This method sets baseline (current moment in time) for all future monitored \"*New*\" KPI events - e.g. new alarms raised, new tests failures etc.. Intention : MODIFIER setBaseline: instance-level modifier API setBaseline of class sup.SupervisionGroup instanceFullName : distinguished/instance name of called object The time of setting the baseline.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSupSupervisionGroupSetBaseline" }, "task": true }, { "name": "restSupSupervisionManagerClearAllHistory", "summary": "rest_sup_SupervisionManager_clearAllHistory", "description": "rest_sup_SupervisionManager_clearAllHistory", "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": "/restSupSupervisionManagerClearAllHistory" }, "task": true }, { "name": "restSupSupervisionManagerDumpLog", "summary": "dumpLog", "description": "Writes details of the cache contents into the system log. Intention : RETRIEVER dumpLog: class-level retriever API dumpLog on default instance sup of class sup.SupervisionManager Cache contents info.", "input": [ { "name": "body", "type": "object", "info": ": {\"logLevel\": 123, \"details\": 123}", "required": false, "schema": { "type": "object", "required": [ "details", "logLevel" ], "properties": { "logLevel": { "type": "integer", "description": " Logging level." }, "details": { "type": "integer", "description": " Details level.0: very brief info,1: more details,2: most details" } }, "description": "Model containing the method level model for SupervisionManager.dumpLog to decode json data to internal NFM-P object model" } } ], "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": "/restSupSupervisionManagerDumpLog" }, "task": true }, { "name": "restSupSupervisionManagerGetGroupsByFdn", "summary": "getGroupsByFdn", "description": "This method returns a list of supervision group view fdns based on the monitored fdn. Intention : RETRIEVER getGroupsByFdn: instance-level retriever API getGroupsByFdn on default instance sup of class sup.SupervisionManager list of supervision group fdn.", "input": [ { "name": "className", "type": "string", "info": ": string", "required": false, "schema": { "title": "className", "type": "string" } }, { "name": "monitoredFdn", "type": "string", "info": ": string", "required": false, "schema": { "title": "monitoredFdn", "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": "/restSupSupervisionManagerGetGroupsByFdn" }, "task": true }, { "name": "restSupSupervisionManagerGetGroupsByFdnForUser", "summary": "getGroupsByFdnForUser", "description": "This method returns a supervision group view fdns based on the monitored fdn and the user's access rights. At this moment, this method will be called only by service supervision to enable access control. When the user searches a service or group on the search bar, this method will be called and we will search that service supervision group and return its supervision group and summary view (first match) Intention : RETRIEVER getGroupsByFdnForUser: instance-level retriever API getGroupsByFdnFo...(description truncated)", "input": [ { "name": "className", "type": "string", "info": ": string", "required": false, "schema": { "title": "className", "type": "string" } }, { "name": "monitoredFdn", "type": "string", "info": ": string", "required": false, "schema": { "title": "monitoredFdn", "type": "string" } }, { "name": "user", "type": "string", "info": ": string", "required": false, "schema": { "title": "user", "type": "string" } }, { "name": "appType", "type": "number", "info": ": 123", "required": false, "schema": { "title": "appType", "type": "number" } } ], "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": "/restSupSupervisionManagerGetGroupsByFdnForUser" }, "task": true }, { "name": "restSupSupervisionManagerKeepAliveUpdate", "summary": "keepAliveUpdate", "description": "This method refreshes the last access time of a given sup client (ping). Intention : RETRIEVER keepAliveUpdate: class-level retriever API keepAliveUpdate on default instance sup of class sup.SupervisionManager Period to which the SAM-S client must ping the server.", "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": "/restSupSupervisionManagerKeepAliveUpdate" }, "task": true }, { "name": "restSupSupervisionManagerRebuildCache", "summary": "rest_sup_SupervisionManager_rebuildCache", "description": "rest_sup_SupervisionManager_rebuildCache", "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": "/restSupSupervisionManagerRebuildCache" }, "task": true }, { "name": "restSupSupervisionManagerSearchMonitoredObject", "summary": "searchMonitoredObject", "description": "This method returns list of supervision info for a monitored objects being searched for a given criteria. Intention : RETRIEVER searchMonitoredObject: instance-level retriever API searchMonitoredObject on default instance sup of class sup.SupervisionManager", "input": [ { "name": "body", "type": "object", "info": ": {\"className\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "className", "filter" ], "properties": { "className": { "type": "string", "description": " The class name for the search." }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for SupervisionManager.searchMonitoredObject to decode json data to internal NFM-P object model" } } ], "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": "/restSupSupervisionManagerSearchMonitoredObject" }, "task": true }, { "name": "restSupSupervisionManagerSetBaseline", "summary": "setBaseline", "description": "This method sets baseline (current moment in time) for all future monitored \"*New*\" KPI events - e.g. new alarms raised, new tests failures etc.. Intention : MODIFIER setBaseline: class-level modifier API setBaseline on default instance sup of class sup.SupervisionManager The time of setting the baseline.", "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": "/restSupSupervisionManagerSetBaseline" }, "task": true }, { "name": "restSupSupervisionManagerTakeSnapshot", "summary": "takeSnapshot", "description": "This method takes saves a snapshot of all monitored groups states. Intention : MODIFIER takeSnapshot: class-level modifier API takeSnapshot on default instance sup of class sup.SupervisionManager Time the snapshot was taken at.", "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": "/restSupSupervisionManagerTakeSnapshot" }, "task": true }, { "name": "restSvqAggregationSchedulerConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: instance-level [hierarchical administrative configuration/modification] (modifier) API configure of class svq.AggregationScheduler This API follows hierarchical config model rules. instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restSvqAggregationSchedulerConfigure" }, "task": true }, { "name": "restSvtAbstractTunnelFindCircuits", "summary": "findCircuits", "description": "Intention : RETRIEVER findCircuits: instance-level [object finder] (retriever) API findCircuits of class svt.AbstractTunnel DescendantInfo: svt.BvlanTunnel DescendantInfo: svt.Tunnel DescendantInfo: svt.L2TPv3Tunnel instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restSvtAbstractTunnelFindCircuits" }, "task": true }, { "name": "restSvtAbstractTunnelFindServices", "summary": "findServices", "description": "Intention : RETRIEVER findServices: instance-level [object finder] (retriever) API findServices of class svt.AbstractTunnel DescendantInfo: svt.BvlanTunnel DescendantInfo: svt.Tunnel DescendantInfo: svt.L2TPv3Tunnel instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restSvtAbstractTunnelFindServices" }, "task": true }, { "name": "restSvtAbstractTunnelFindSubscribers", "summary": "findSubscribers", "description": "Intention : RETRIEVER findSubscribers: instance-level [object finder] (retriever) API findSubscribers of class svt.AbstractTunnel DescendantInfo: svt.BvlanTunnel DescendantInfo: svt.Tunnel DescendantInfo: svt.L2TPv3Tunnel instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restSvtAbstractTunnelFindSubscribers" }, "task": true }, { "name": "restSvtAbstractTunnelRediscoverTunnelDestination", "summary": "rediscoverTunnelDestination", "description": "Rediscover the destinations for the tunnels in the specified list, where the tunnels destination node ID is not set. Intention : MODIFIER rediscoverTunnelDestination: class-level modifier API rediscoverTunnelDestination of class svt.AbstractTunnel DescendantInfo: svt.BvlanTunnel DescendantInfo: svt.Tunnel DescendantInfo: svt.L2TPv3Tunnel A list of error messages.", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restSvtAbstractTunnelRediscoverTunnelDestination" }, "task": true }, { "name": "restSvtAbstractTunnelShutDown", "summary": "rest_svt_AbstractTunnel_shutDown", "description": "rest_svt_AbstractTunnel_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSvtAbstractTunnelShutDown" }, "task": true }, { "name": "restSvtAbstractTunnelTurnUp", "summary": "rest_svt_AbstractTunnel_turnUp", "description": "rest_svt_AbstractTunnel_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSvtAbstractTunnelTurnUp" }, "task": true }, { "name": "restSvtL2TPv3TunnelRediscoverDestinationSite", "summary": "rediscoverDestinationSite", "description": "Re-discover the destination site for L2TPv3 tunnel if the destination node ID is not set but far-end IP address is set. Intention : MODIFIER rediscoverDestinationSite: class-level modifier API rediscoverDestinationSite of class svt.L2TPv3Tunnel A list of error messages.", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restSvtL2TPv3TunnelRediscoverDestinationSite" }, "task": true }, { "name": "restSvtManagerDiscoverFlowThruServices", "summary": "rest_svt_Manager_discoverFlowThruServices", "description": "rest_svt_Manager_discoverFlowThruServices", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restSvtManagerDiscoverFlowThruServices" }, "task": true }, { "name": "restSvtMeshSdpBindingRequestClearMeshSdpBfdSession", "summary": "requestClearMeshSdpBfdSession", "description": "Request to clear the VCCV BFD session on this mesh SDP binding. Intention : MODIFIER requestClearMeshSdpBfdSession: instance-level modifier API requestClearMeshSdpBfdSession of class svt.MeshSdpBinding instanceFullName : distinguished/instance name of called object A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSvtMeshSdpBindingRequestClearMeshSdpBfdSession" }, "task": true }, { "name": "restSvtMeshSdpBindingRequestClearMeshSdpBfdStats", "summary": "requestClearMeshSdpBfdStats", "description": "Request to clear the VCCV BFD session stats on this mesh SDP binding. Intention : MODIFIER requestClearMeshSdpBfdStats: instance-level modifier API requestClearMeshSdpBfdStats of class svt.MeshSdpBinding instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSvtMeshSdpBindingRequestClearMeshSdpBfdStats" }, "task": true }, { "name": "restSvtSpokeSdpBindingRequestClearSpokeSdpBfdSession", "summary": "requestClearSpokeSdpBfdSession", "description": "Request to clear the VCCV BFD session on this spoke SDP binding. Intention : MODIFIER requestClearSpokeSdpBfdSession: instance-level modifier API requestClearSpokeSdpBfdSession of class svt.SpokeSdpBinding instanceFullName : distinguished/instance name of called object A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSvtSpokeSdpBindingRequestClearSpokeSdpBfdSession" }, "task": true }, { "name": "restSvtSpokeSdpBindingRequestClearSpokeSdpBfdStats", "summary": "requestClearSpokeSdpBfdStats", "description": "Request to clear the VCCV BFD session stats on this spoke SDP binding. Intention : MODIFIER requestClearSpokeSdpBfdStats: instance-level modifier API requestClearSpokeSdpBfdStats of class svt.SpokeSdpBinding instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSvtSpokeSdpBindingRequestClearSpokeSdpBfdStats" }, "task": true }, { "name": "restSvtTunnelConfigure", "summary": "configure", "description": "Intention : MODIFIER configure: class-level [hierarchical administrative configuration/modification] (modifier) API configure of class svt.Tunnel This API follows hierarchical config model rules.", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\"}", "required": false, "schema": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } } ], "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": "/restSvtTunnelConfigure" }, "task": true }, { "name": "restSvtTunnelFindServiceSites", "summary": "findServiceSites", "description": "Intention : RETRIEVER findServiceSites: instance-level [object finder] (retriever) API findServiceSites of class svt.Tunnel instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restSvtTunnelFindServiceSites" }, "task": true }, { "name": "restSwBackupRestoreManagerBackup", "summary": "rest_sw_BackupRestoreManager_backup", "description": "rest_sw_BackupRestoreManager_backup", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSwBackupRestoreManagerBackup" }, "task": true }, { "name": "restSwBackupRestoreManagerBackupStatusRefresh", "summary": "rest_sw_BackupRestoreManager_backupStatusRefresh", "description": "rest_sw_BackupRestoreManager_backupStatusRefresh", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSwBackupRestoreManagerBackupStatusRefresh" }, "task": true }, { "name": "restSwBackupRestoreManagerRestore", "summary": "rest_sw_BackupRestoreManager_restore", "description": "rest_sw_BackupRestoreManager_restore", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"backupFolderDescriptorPointer\": \"string\", \"restoreBof\": \"boolean\", \"restoreConfig\": \"boolean\", \"force\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "backupFolderDescriptorPointer", "force", "restoreBof", "restoreConfig" ], "properties": { "backupFolderDescriptorPointer": { "type": "string", "description": " " }, "restoreBof": { "type": "boolean", "description": " ", "default": false }, "restoreConfig": { "type": "boolean", "description": " ", "default": false }, "force": { "type": "boolean", "description": " default:false", "default": false } }, "description": "Model containing the method level model for BackupRestoreManager.restore to decode json data to internal NFM-P object model" } } ], "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": "/restSwBackupRestoreManagerRestore" }, "task": true }, { "name": "restSwBackupRestoreManagerSaveConfig", "summary": "rest_sw_BackupRestoreManager_saveConfig", "description": "rest_sw_BackupRestoreManager_saveConfig", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSwBackupRestoreManagerSaveConfig" }, "task": true }, { "name": "restSwLogRetrievalManagerRetrieveLogs", "summary": "rest_sw_LogRetrievalManager_retrieveLogs", "description": "rest_sw_LogRetrievalManager_retrieveLogs", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSwLogRetrievalManagerRetrieveLogs" }, "task": true }, { "name": "restSwRadioRSLRetrievalManagerRetrieveRadioRSL", "summary": "rest_sw_RadioRSLRetrievalManager_retrieveRadioRSL", "description": "rest_sw_RadioRSLRetrievalManager_retrieveRadioRSL", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restSwRadioRSLRetrievalManagerRetrieveRadioRSL" }, "task": true }, { "name": "restSwRanBackupFolderDescriptorRestoreRefresh", "summary": "rest_sw_RanBackupFolderDescriptor_restoreRefresh", "description": "rest_sw_RanBackupFolderDescriptor_restoreRefresh", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restSwRanBackupFolderDescriptorRestoreRefresh" }, "task": true }, { "name": "restSynceSyncEDomainFindSyncESites", "summary": "findSyncESites", "description": "Finds all Sync-E Sites belonging to this Sync-E Domain. Intention : RETRIEVER findSyncESites: class-level [object finder] (retriever) API findSyncESites of class synce.SyncEDomain", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restSynceSyncEDomainFindSyncESites" }, "task": true }, { "name": "restTcaTCAPolicyAddMonitoredObjects", "summary": "rest_tca_TCAPolicy_addMonitoredObjects", "description": "rest_tca_TCAPolicy_addMonitoredObjects", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restTcaTCAPolicyAddMonitoredObjects" }, "task": true }, { "name": "restTcaTCAPolicyAddMonitoredObjectsUsingFilter", "summary": "rest_tca_TCAPolicy_addMonitoredObjectsUsingFilter", "description": "rest_tca_TCAPolicy_addMonitoredObjectsUsingFilter", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restTcaTCAPolicyAddMonitoredObjectsUsingFilter" }, "task": true }, { "name": "restTcaTCAPolicyRemoveMonitoredObjects", "summary": "rest_tca_TCAPolicy_removeMonitoredObjects", "description": "rest_tca_TCAPolicy_removeMonitoredObjects", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restTcaTCAPolicyRemoveMonitoredObjects" }, "task": true }, { "name": "restTcaTCAPolicyRemoveMonitoredObjectsUsingFilter", "summary": "rest_tca_TCAPolicy_removeMonitoredObjectsUsingFilter", "description": "rest_tca_TCAPolicy_removeMonitoredObjectsUsingFilter", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restTcaTCAPolicyRemoveMonitoredObjectsUsingFilter" }, "task": true }, { "name": "restTdmTdmFacilityFindApsGroup", "summary": "findApsGroup", "description": "This method finds all the associated APS group Intention : RETRIEVER findApsGroup: instance-level [object finder] (retriever) API findApsGroup of class tdm.TdmFacility DescendantInfo: tdm.AUn instanceFullName : distinguished/instance name of called object List of TDM FacilityProtectionGroupList", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restTdmTdmFacilityFindApsGroup" }, "task": true }, { "name": "restTdmTdmFacilityFindVcnCrossConnects", "summary": "findVcnCrossConnects", "description": "This method finds all the associated TDM cross connect Intention : RETRIEVER findVcnCrossConnects: instance-level [object finder] (retriever) API findVcnCrossConnects of class tdm.TdmFacility DescendantInfo: tdm.AUn instanceFullName : distinguished/instance name of called object List of TDM CrossConnect", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restTdmTdmFacilityFindVcnCrossConnects" }, "task": true }, { "name": "restTdmTdmFacilityProtectionGroupFindVcnCrossConnects", "summary": "findVcnCrossConnects", "description": "This method finds all the underlying TDM cross connect Intention : RETRIEVER findVcnCrossConnects: instance-level [object finder] (retriever) API findVcnCrossConnects of class tdm.TdmFacilityProtectionGroup instanceFullName : distinguished/instance name of called object List of TDM CrossConnect", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restTdmTdmFacilityProtectionGroupFindVcnCrossConnects" }, "task": true }, { "name": "restTdmTdmFacilityProtectionGroupUnProtect", "summary": "rest_tdm_TdmFacilityProtectionGroup_unProtect", "description": "rest_tdm_TdmFacilityProtectionGroup_unProtect", "input": [ { "name": "body", "type": "object", "info": ": {\"aInFdns\": \"array\", \"aInRemoveWorkingPath\": \"boolean\"}", "required": false, "schema": { "type": "object", "properties": { "aInFdns": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "aInRemoveWorkingPath": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for TdmFacilityProtectionGroup.unProtect to decode json data to internal NFM-P object model" } } ], "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": "/restTdmTdmFacilityProtectionGroupUnProtect" }, "task": true }, { "name": "restTdmVcnCrossConnectFindValidAunCtpsForNewVcnXc", "summary": "findValidAunCtpsForNewVcnXc", "description": "This method finds all Aun Ctps not part of any existing Vcn Cross Connects. Intention : RETRIEVER findValidAunCtpsForNewVcnXc: class-level [object finder] (retriever) API findValidAunCtpsForNewVcnXc of class tdm.VcnCrossConnect", "input": [ { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "rate", "type": "string", "info": ": string", "required": false, "schema": { "title": "rate", "type": "string" } }, { "name": "ctpAPointer", "type": "string", "info": ": string", "required": false, "schema": { "title": "ctpAPointer", "type": "string" } }, { "name": "ctpZPointer", "type": "string", "info": ": string", "required": false, "schema": { "title": "ctpZPointer", "type": "string" } }, { "name": "isBiDirectional", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "isBiDirectional", "type": "boolean" } }, { "name": "isAEndSelection", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "isAEndSelection", "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": "/restTdmVcnCrossConnectFindValidAunCtpsForNewVcnXc" }, "task": true }, { "name": "restTdmequipmentAdaptiveClockHistoryRetrieveAdaptiveClockHistory", "summary": "retrieveAdaptiveClockHistory", "description": "Method used to query the NE for the ACR history of a particular DS1E1Channel. Intention : RETRIEVER retrieveAdaptiveClockHistory: class-level retriever API retrieveAdaptiveClockHistory of class tdmequipment.AdaptiveClockHistory", "input": [ { "name": "body", "type": "object", "info": ": {\"aInChannelName\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInChannelName": { "type": "string" }, "timeout": { "type": "integer", "description": " The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns." } }, "description": "Model containing the method level model for AdaptiveClockHistory.retrieveAdaptiveClockHistory to decode json data to internal NFM-P object model" } } ], "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": "/restTdmequipmentAdaptiveClockHistoryRetrieveAdaptiveClockHistory" }, "task": true }, { "name": "restTodPolicyGetTimeZone", "summary": "getTimeZone", "description": "Intention : RETRIEVER getTimeZone: class-level retriever API getTimeZone of class tod.Policy", "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": "/restTodPolicyGetTimeZone" }, "task": true }, { "name": "restTodTimeRangeEntryAssignmentGetTimeRangeEntryAssignments", "summary": "getTimeRangeEntryAssignments", "description": "Intention : RETRIEVER getTimeRangeEntryAssignments: class-level retriever API getTimeRangeEntryAssignments of class tod.TimeRangeEntryAssignment List of TimeRangeEntryAssignment info objects that yielded from the provided parameters.", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"timeOfDayEntryType\": \"string\", \"assignedObjPointer\": \"string\", \"startDate\": 123, \"endDate\": 123}", "required": false, "schema": { "type": "object", "required": [ "assignedObjPointer", "endDate", "objectClassName", "startDate", "timeOfDayEntryType" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "timeOfDayEntryType": { "type": "string" }, "assignedObjPointer": { "type": "string" }, "startDate": { "type": "integer" }, "endDate": { "type": "integer" } }, "description": "Model containing the method level model for struct TimeRangeEntryAssignmentSearchConfig. to decode json data to internal NFM-P object model" } } ], "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": "/restTodTimeRangeEntryAssignmentGetTimeRangeEntryAssignments" }, "task": true }, { "name": "restTopologyAbstractImpactAnalysisTimeRangeImpactAnalysis", "summary": "impactAnalysis", "description": "Used to calculate the historical impact analysis results. Intention : MODIFIER impactAnalysis: instance-level modifier API impactAnalysis of class topology.AbstractImpactAnalysisTimeRange DescendantInfo: topology.BgpImpactAnalysisTimeRange DescendantInfo: topology.ServiceImpactAnalysisTimeRange DescendantInfo: topology.ServiceBgpImpactAnalysisTimeRange DescendantInfo: topology.CompSvcImpactAnalysisTimeRange DescendantInfo: topology.ImpactAnalysisTimeRange instanceFullName : disti...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restTopologyAbstractImpactAnalysisTimeRangeImpactAnalysis" }, "task": true }, { "name": "restTopologyAbstractImpactAnalysisTimeRangeImpactAnalysisDetails", "summary": "impactAnalysisDetails", "description": "Details for Historical Impact Analysis results. Intention : MODIFIER impactAnalysisDetails: instance-level modifier API impactAnalysisDetails of class topology.AbstractImpactAnalysisTimeRange DescendantInfo: topology.BgpImpactAnalysisTimeRange DescendantInfo: topology.ServiceImpactAnalysisTimeRange DescendantInfo: topology.ServiceBgpImpactAnalysisTimeRange DescendantInfo: topology.CompSvcImpactAnalysisTimeRange DescendantInfo: topology.ImpactAnalysisTimeRange instanceFullName : d...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectType\": 123, \"reason\": 123, \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "fields", "filter", "objectType", "pageNumber", "pageSize", "reason", "sortFields" ], "properties": { "objectType": { "type": "integer", "description": " " }, "reason": { "type": "integer", "description": " " }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "fields": { "type": "array", "description": " Sorting fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for AbstractImpactAnalysisTimeRange.impactAnalysisDetails to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyAbstractImpactAnalysisTimeRangeImpactAnalysisDetails" }, "task": true }, { "name": "restTopologyAreaCleanUpReference", "summary": "rest_topology_Area_cleanUpReference", "description": "rest_topology_Area_cleanUpReference", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restTopologyAreaCleanUpReference" }, "task": true }, { "name": "restTopologyAreaFindAllCheckpoints", "summary": "findAllCheckpoints", "description": "Find all the checkpoints that exist for this checkpointable object. Intention : RETRIEVER findAllCheckpoints: instance-level [object finder] (retriever) API findAllCheckpoints of class topology.Area instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restTopologyAreaFindAllCheckpoints" }, "task": true }, { "name": "restTopologyAutonomousSystemCleanUpReference", "summary": "rest_topology_AutonomousSystem_cleanUpReference", "description": "rest_topology_AutonomousSystem_cleanUpReference", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restTopologyAutonomousSystemCleanUpReference" }, "task": true }, { "name": "restTopologyAutonomousSystemFindActivePrimaryStaticRoutes", "summary": "findActivePrimaryStaticRoutes", "description": "finds all static routes on this admin domain that have the lowest metric for that destination AND are active Intention : RETRIEVER findActivePrimaryStaticRoutes: instance-level [object finder] (retriever) API findActivePrimaryStaticRoutes of class topology.AutonomousSystem instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "fields", "pageNumber", "pageSize", "sortFields" ], "properties": { "fields": { "type": "array", "description": " Sorting fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for AutonomousSystem.findActivePrimaryStaticRoutes to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyAutonomousSystemFindActivePrimaryStaticRoutes" }, "task": true }, { "name": "restTopologyAutonomousSystemFindActiveSecondaryStaticRoutes", "summary": "findActiveSecondaryStaticRoutes", "description": "finds all static routes on this admin domain that do not have the lowest metric for that destination AND are active Intention : RETRIEVER findActiveSecondaryStaticRoutes: instance-level [object finder] (retriever) API findActiveSecondaryStaticRoutes of class topology.AutonomousSystem instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "fields", "pageNumber", "pageSize", "sortFields" ], "properties": { "fields": { "type": "array", "description": " Sorting fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for AutonomousSystem.findActiveSecondaryStaticRoutes to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyAutonomousSystemFindActiveSecondaryStaticRoutes" }, "task": true }, { "name": "restTopologyAutonomousSystemFindAllStaticRoutes", "summary": "findAllStaticRoutes", "description": "finds all static routes on this admin domain Intention : RETRIEVER findAllStaticRoutes: instance-level [object finder] (retriever) API findAllStaticRoutes of class topology.AutonomousSystem instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "fields", "pageNumber", "pageSize", "sortFields" ], "properties": { "fields": { "type": "array", "description": " Sorting fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for AutonomousSystem.findAllStaticRoutes to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyAutonomousSystemFindAllStaticRoutes" }, "task": true }, { "name": "restTopologyAutonomousSystemFindInactivePrimaryStaticRoutes", "summary": "findInactivePrimaryStaticRoutes", "description": "finds all static routes on this admin domain that have the lowest metric for that destination AND are inactive Intention : RETRIEVER findInactivePrimaryStaticRoutes: instance-level [object finder] (retriever) API findInactivePrimaryStaticRoutes of class topology.AutonomousSystem instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "fields", "pageNumber", "pageSize", "sortFields" ], "properties": { "fields": { "type": "array", "description": " Sorting fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for AutonomousSystem.findInactivePrimaryStaticRoutes to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyAutonomousSystemFindInactivePrimaryStaticRoutes" }, "task": true }, { "name": "restTopologyAutonomousSystemFindInactiveSecondaryStaticRoutes", "summary": "findInactiveSecondaryStaticRoutes", "description": "finds all static routes on this admin domain that do not have the lowest metric for that destination AND are inactive Intention : RETRIEVER findInactiveSecondaryStaticRoutes: instance-level [object finder] (retriever) API findInactiveSecondaryStaticRoutes of class topology.AutonomousSystem instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "fields", "pageNumber", "pageSize", "sortFields" ], "properties": { "fields": { "type": "array", "description": " Sorting fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for AutonomousSystem.findInactiveSecondaryStaticRoutes to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyAutonomousSystemFindInactiveSecondaryStaticRoutes" }, "task": true }, { "name": "restTopologyBaseLinkFindObjectsOnLinkOssi", "summary": "findObjectsOnLinkOssi", "description": "Find all the associated IP Path Monitors that exist on IGP Link(s). Intention : RETRIEVER findObjectsOnLinkOssi: instance-level [object finder] (retriever) API findObjectsOnLinkOssi of class topology.BaseLink DescendantInfo: topology.IsisLink DescendantInfo: topology.NonRoutedLink DescendantInfo: topology.OspfLink DescendantInfo: topology.IgpLink instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectType\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "filter", "objectType", "pageNumber", "pageSize" ], "properties": { "objectType": { "type": "string", "description": " " }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for BaseLink.findObjectsOnLinkOssi to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyBaseLinkFindObjectsOnLinkOssi" }, "task": true }, { "name": "restTopologyBgpAutonomousSystemRetrieveBgpEventTopNContributers", "summary": "retrieveBgpEventTopNContributers", "description": "Intention : RETRIEVER retrieveBgpEventTopNContributers: instance-level retriever API retrieveBgpEventTopNContributers of class topology.BgpAutonomousSystem instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"numOfResults\": 123, \"contributerType\": \"string\", \"changeType\": \"array\", \"addrType\": \"string\", \"startTime\": 123, \"endTime\": 123}", "required": false, "schema": { "type": "object", "required": [ "addrType", "changeType", "contributerType", "endTime", "numOfResults", "startTime" ], "properties": { "numOfResults": { "type": "integer", "description": " The number of results to retrieve, from 1 to 100" }, "contributerType": { "type": "string", "description": " The type of contributer" }, "changeType": { "type": "array", "description": " The event change type", "items": { "type": "string" } }, "addrType": { "type": "string", "description": " The BGP Address type" }, "startTime": { "type": "integer", "description": " " }, "endTime": { "type": "integer", "description": " " } }, "description": "Model containing the method level model for BgpAutonomousSystem.retrieveBgpEventTopNContributers to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyBgpAutonomousSystemRetrieveBgpEventTopNContributers" }, "task": true }, { "name": "restTopologyBgpAutonomousSystemUpdateBgpAsTopology", "summary": "rest_topology_BgpAutonomousSystem_updateBgpAsTopology", "description": "rest_topology_BgpAutonomousSystem_updateBgpAsTopology", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restTopologyBgpAutonomousSystemUpdateBgpAsTopology" }, "task": true }, { "name": "restTopologyBgpAutonomousSystemUpdateBgpRibInfo", "summary": "rest_topology_BgpAutonomousSystem_updateBgpRibInfo", "description": "rest_topology_BgpAutonomousSystem_updateBgpRibInfo", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restTopologyBgpAutonomousSystemUpdateBgpRibInfo" }, "task": true }, { "name": "restTopologyBgpAutonomousSystemUpdateBgpRouteTargets", "summary": "rest_topology_BgpAutonomousSystem_updateBgpRouteTargets", "description": "rest_topology_BgpAutonomousSystem_updateBgpRouteTargets", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restTopologyBgpAutonomousSystemUpdateBgpRouteTargets" }, "task": true }, { "name": "restTopologyBgpEventPartitionManagerCleanupEvents", "summary": "rest_topology_BgpEventPartitionManager_cleanupEvents", "description": "rest_topology_BgpEventPartitionManager_cleanupEvents", "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": "/restTopologyBgpEventPartitionManagerCleanupEvents" }, "task": true }, { "name": "restTopologyBgpEventPartitionManagerCleanupOldestPartition", "summary": "rest_topology_BgpEventPartitionManager_cleanupOldestPartition", "description": "rest_topology_BgpEventPartitionManager_cleanupOldestPartition", "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": "/restTopologyBgpEventPartitionManagerCleanupOldestPartition" }, "task": true }, { "name": "restTopologyBgpEventPartitionManagerRetrieveBgpEventStartFromBgpStatInterval", "summary": "retrieveBgpEventStartFromBgpStatInterval", "description": "Intention : RETRIEVER retrieveBgpEventStartFromBgpStatInterval: instance-level retriever API retrieveBgpEventStartFromBgpStatInterval on default instance BePrtMgr of class topology.BgpEventPartitionManager", "input": [ { "name": "body", "type": "object", "info": ": {\"bgpAsFdn\": \"string\", \"statStartTime\": 123, \"statEndTime\": 123}", "required": false, "schema": { "type": "object", "required": [ "bgpAsFdn", "statEndTime", "statStartTime" ], "properties": { "bgpAsFdn": { "type": "string", "description": " " }, "statStartTime": { "type": "integer", "description": " " }, "statEndTime": { "type": "integer", "description": " " } }, "description": "Model containing the method level model for BgpEventPartitionManager.retrieveBgpEventStartFromBgpStatInterval to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyBgpEventPartitionManagerRetrieveBgpEventStartFromBgpStatInterval" }, "task": true }, { "name": "restTopologyBgpImpactAnalysisTimeRangeBgpImpactAnalysis", "summary": "bgpImpactAnalysis", "description": "Used to calculate the bgp historical impact analysis results. Intention : MODIFIER bgpImpactAnalysis: instance-level modifier API bgpImpactAnalysis of class topology.BgpImpactAnalysisTimeRange DescendantInfo: topology.ServiceBgpImpactAnalysisTimeRange instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restTopologyBgpImpactAnalysisTimeRangeBgpImpactAnalysis" }, "task": true }, { "name": "restTopologyBgpImpactAnalysisTimeRangeBgpImpactAnalysisDetails", "summary": "bgpImpactAnalysisDetails", "description": "Details for Historical Impact Analysis results. Reason can be specified. Reason has the following int values: Unreachable at least once during this period =1, Advertised as a New route at least once =2, Added at least once =3, Flapped = 4, Redundancy Lost at least once = 5, Switched Next Hop, Same Originator = 6, Switched Next Hop, Different Originator = 7, Switched at least once to longer AS-Path = 8, MED change at least once = 9, Throttled BGP events count = 10 Intention : RETRIEVER bgpImpa...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"reason\": 123, \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "fields", "filter", "pageNumber", "pageSize", "reason", "sortFields" ], "properties": { "reason": { "type": "integer", "description": " " }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "fields": { "type": "array", "description": " Sorting fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for BgpImpactAnalysisTimeRange.bgpImpactAnalysisDetails to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyBgpImpactAnalysisTimeRangeBgpImpactAnalysisDetails" }, "task": true }, { "name": "restTopologyBgpImpactAnalysisTimeRangeBgpPerNextHopEventAnalysis", "summary": "bgpPerNextHopEventAnalysis", "description": "Intention : RETRIEVER bgpPerNextHopEventAnalysis: instance-level retriever API bgpPerNextHopEventAnalysis of class topology.BgpImpactAnalysisTimeRange DescendantInfo: topology.ServiceBgpImpactAnalysisTimeRange instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restTopologyBgpImpactAnalysisTimeRangeBgpPerNextHopEventAnalysis" }, "task": true }, { "name": "restTopologyBgpImpactAnalysisTimeRangeBgpPerNextHopSummary", "summary": "bgpPerNextHopSummary", "description": "Intention : RETRIEVER bgpPerNextHopSummary: instance-level retriever API bgpPerNextHopSummary of class topology.BgpImpactAnalysisTimeRange DescendantInfo: topology.ServiceBgpImpactAnalysisTimeRange instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"nextHopAddr\": \"string\", \"eventAdded\": \"boolean\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "eventAdded", "fields", "filter", "nextHopAddr", "pageNumber", "pageSize", "sortFields" ], "properties": { "nextHopAddr": { "type": "string", "description": " " }, "eventAdded": { "type": "boolean", "description": " ", "default": false }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "fields": { "type": "array", "description": " Sorting fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for BgpImpactAnalysisTimeRange.bgpPerNextHopSummary to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyBgpImpactAnalysisTimeRangeBgpPerNextHopSummary" }, "task": true }, { "name": "restTopologyBgpImpactAnalysisTimeRangeBgpPrefixAnalysis", "summary": "bgpPrefixAnalysis", "description": "Intention : RETRIEVER bgpPrefixAnalysis: instance-level retriever API bgpPrefixAnalysis of class topology.BgpImpactAnalysisTimeRange DescendantInfo: topology.ServiceBgpImpactAnalysisTimeRange instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restTopologyBgpImpactAnalysisTimeRangeBgpPrefixAnalysis" }, "task": true }, { "name": "restTopologyBgpImpactAnalysisTimeRangeBgpRetrieveEventForNextHop", "summary": "bgpRetrieveEventForNextHop", "description": "Details for Historical Impact Analysis results. Intention : RETRIEVER bgpRetrieveEventForNextHop: instance-level retriever API bgpRetrieveEventForNextHop of class topology.BgpImpactAnalysisTimeRange DescendantInfo: topology.ServiceBgpImpactAnalysisTimeRange instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"nextHopAddr\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "fields", "filter", "nextHopAddr", "pageNumber", "pageSize", "sortFields" ], "properties": { "nextHopAddr": { "type": "string", "description": " " }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "fields": { "type": "array", "description": " Sorting fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for BgpImpactAnalysisTimeRange.bgpRetrieveEventForNextHop to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyBgpImpactAnalysisTimeRangeBgpRetrieveEventForNextHop" }, "task": true }, { "name": "restTopologyBgpMonitoredPrefixBulkDelete", "summary": "rest_topology_BgpMonitoredPrefix_bulkDelete", "description": "rest_topology_BgpMonitoredPrefix_bulkDelete", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restTopologyBgpMonitoredPrefixBulkDelete" }, "task": true }, { "name": "restTopologyBgpMonitoredPrefixCaptureCurrentPrefix", "summary": "rest_topology_BgpMonitoredPrefix_captureCurrentPrefix", "description": "rest_topology_BgpMonitoredPrefix_captureCurrentPrefix", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restTopologyBgpMonitoredPrefixCaptureCurrentPrefix" }, "task": true }, { "name": "restTopologyBgpPrefixListAbortRetrievePrefixList", "summary": "rest_topology_BgpPrefixList_abortRetrievePrefixList", "description": "rest_topology_BgpPrefixList_abortRetrievePrefixList", "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": "/restTopologyBgpPrefixListAbortRetrievePrefixList" }, "task": true }, { "name": "restTopologyCheckpointAutoCreateCheckpoints", "summary": "rest_topology_Checkpoint_autoCreateCheckpoints", "description": "rest_topology_Checkpoint_autoCreateCheckpoints", "input": [ { "name": "body", "type": "object", "info": ": {\"igpAdminDomainPointer\": \"string\", \"protocolMask\": \"array\"}", "required": false, "schema": { "type": "object", "required": [ "igpAdminDomainPointer", "protocolMask" ], "properties": { "igpAdminDomainPointer": { "type": "string", "description": " The pointer to the IGP admin domain that is beingcheckpointed." }, "protocolMask": { "type": "array", "description": " The protocols to create the checkpoints for.", "items": { "type": "string" } } }, "description": "Model containing the method level model for Checkpoint.autoCreateCheckpoints to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyCheckpointAutoCreateCheckpoints" }, "task": true }, { "name": "restTopologyCheckpointForceCleanupCheckpoints", "summary": "rest_topology_Checkpoint_forceCleanupCheckpoints", "description": "rest_topology_Checkpoint_forceCleanupCheckpoints", "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": "/restTopologyCheckpointForceCleanupCheckpoints" }, "task": true }, { "name": "restTopologyCheckpointGetCpTopology", "summary": "getCpTopology", "description": "Intention : RETRIEVER getCpTopology: class-level retriever API getCpTopology of class topology.Checkpoint DescendantInfo: topology.OspfCheckpoint DescendantInfo: topology.IsisCheckpoint", "input": [ { "name": "body", "type": "object", "info": ": {\"checkpointId\": 123, \"asNumber\": 123, \"asName\": \"string\", \"protocol\": \"string\", \"fullClassName\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "asName", "asNumber", "checkpointId", "fullClassName", "protocol" ], "properties": { "checkpointId": { "type": "integer", "description": " Checkpoint ID." }, "asNumber": { "type": "integer", "description": " The IGP administrative domain number of the CP." }, "asName": { "type": "string", "description": " The IGP administrative domain name of the CP." }, "protocol": { "type": "string", "description": " The protocol that the CP belongs to. Only OSPF and ISIS aresupported." }, "fullClassName": { "type": "string", "description": " Package qualified class name in dot separated formatEXAMPLE: topology.Router, topology.OspfLink." } }, "description": "Model containing the method level model for Checkpoint.getCpTopology to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyCheckpointGetCpTopology" }, "task": true }, { "name": "restTopologyCpaaSwitchover", "summary": "rest_topology_Cpaa_switchover", "description": "rest_topology_Cpaa_switchover", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restTopologyCpaaSwitchover" }, "task": true }, { "name": "restTopologyCpamStatisticManagerEnableUtilizationStats", "summary": "rest_topology_CpamStatisticManager_enableUtilizationStats", "description": "rest_topology_CpamStatisticManager_enableUtilizationStats", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restTopologyCpamStatisticManagerEnableUtilizationStats" }, "task": true }, { "name": "restTopologyCpamStatisticManagerGetIfUtilizationStats", "summary": "getIfUtilizationStats", "description": "Retrieves statistics for interface utilization. Intention : RETRIEVER getIfUtilizationStats: class-level retriever API getIfUtilizationStats on default instance statsMgr of class topology.CpamStatisticManager", "input": [ { "name": "body", "type": "object", "info": ": {\"endRangeSet\": \"array\", \"timestamp\": 123, \"asFdn\": \"string\", \"isCalBasedOnIntSpeed\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "asFdn", "endRangeSet", "isCalBasedOnIntSpeed", "timestamp" ], "properties": { "endRangeSet": { "type": "array", "description": " The set of utilization ending ranges.", "uniqueItems": true, "items": { "type": "integer" } }, "timestamp": { "type": "integer", "description": " " }, "asFdn": { "type": "string", "description": " " }, "isCalBasedOnIntSpeed": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for CpamStatisticManager.getIfUtilizationStats to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyCpamStatisticManagerGetIfUtilizationStats" }, "task": true }, { "name": "restTopologyCpamStatisticManagerGetIfsForUtilizationRange", "summary": "getIfsForUtilizationRange", "description": "Retrieves the list of interfaces for a utilization range. Intention : RETRIEVER getIfsForUtilizationRange: class-level retriever API getIfsForUtilizationRange on default instance statsMgr of class topology.CpamStatisticManager The list of interface utilization detail information.", "input": [ { "name": "body", "type": "object", "info": ": {\"statsType\": \"string\", \"rangeStart\": 123, \"rangeEnd\": 123, \"timestamp\": 123, \"asFdn\": \"string\", \"isCalBasedOnIntSpeed\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "asFdn", "isCalBasedOnIntSpeed", "rangeEnd", "rangeStart", "statsType", "timestamp" ], "properties": { "statsType": { "type": "string", "description": " The CPAM stats type, could be IP interface or MPLS interface." }, "rangeStart": { "type": "integer", "description": " The start value of utilization range." }, "rangeEnd": { "type": "integer", "description": " The end value of utilization range." }, "timestamp": { "type": "integer", "description": " " }, "asFdn": { "type": "string", "description": " " }, "isCalBasedOnIntSpeed": { "type": "boolean", "description": " ", "default": false } }, "description": "Model containing the method level model for CpamStatisticManager.getIfsForUtilizationRange to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyCpamStatisticManagerGetIfsForUtilizationRange" }, "task": true }, { "name": "restTopologyIgpLinkFindAllCheckpoints", "summary": "findAllCheckpoints", "description": "Find all the checkpoints that exist for this checkpointable object. Intention : RETRIEVER findAllCheckpoints: instance-level [object finder] (retriever) API findAllCheckpoints of class topology.IgpLink DescendantInfo: topology.IsisLink DescendantInfo: topology.OspfLink instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restTopologyIgpLinkFindAllCheckpoints" }, "task": true }, { "name": "restTopologyIgpMonitoredPrefixCaptureCurrentPrefix", "summary": "rest_topology_IgpMonitoredPrefix_captureCurrentPrefix", "description": "rest_topology_IgpMonitoredPrefix_captureCurrentPrefix", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restTopologyIgpMonitoredPrefixCaptureCurrentPrefix" }, "task": true }, { "name": "restTopologyIgpPrefixListAbortRetrievePrefixList", "summary": "rest_topology_IgpPrefixList_abortRetrievePrefixList", "description": "rest_topology_IgpPrefixList_abortRetrievePrefixList", "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": "/restTopologyIgpPrefixListAbortRetrievePrefixList" }, "task": true }, { "name": "restTopologyNREdgeDiscoveryPolicyExecuteNonRoutedEdgeDiscoveryPolicy", "summary": "rest_topology_NREdgeDiscoveryPolicy_executeNonRoutedEdgeDiscoveryPolicy", "description": "rest_topology_NREdgeDiscoveryPolicy_executeNonRoutedEdgeDiscoveryPolicy", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restTopologyNREdgeDiscoveryPolicyExecuteNonRoutedEdgeDiscoveryPolicy" }, "task": true }, { "name": "restTopologyRouteManagerDeregisterRoutes", "summary": "rest_topology_RouteManager_deregisterRoutes", "description": "rest_topology_RouteManager_deregisterRoutes", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restTopologyRouteManagerDeregisterRoutes" }, "task": true }, { "name": "restTopologyRouteManagerRebuildRoutes", "summary": "rest_topology_RouteManager_rebuildRoutes", "description": "rest_topology_RouteManager_rebuildRoutes", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restTopologyRouteManagerRebuildRoutes" }, "task": true }, { "name": "restTopologyRouteManagerRegisterRoutes", "summary": "rest_topology_RouteManager_registerRoutes", "description": "rest_topology_RouteManager_registerRoutes", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restTopologyRouteManagerRegisterRoutes" }, "task": true }, { "name": "restTopologyRouteManagerRetrieveRoutes", "summary": "retrieveRoutes", "description": "Used by the application to retrieve the paths for the given set of route keys. Intention : RETRIEVER retrieveRoutes: instance-level retriever API retrieveRoutes of class topology.RouteManager DescendantInfo: monpath.InternalRouteManager instanceFullName : distinguished/instance name of called object A map of the {code}topology.RouteKey{ code} to a RouteResult.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restTopologyRouteManagerRetrieveRoutes" }, "task": true }, { "name": "restTopologyRouteProfileManagerRetrieveVpnBgpRouteProfilesAssociatedWithService", "summary": "retrieveVpnBgpRouteProfilesAssociatedWithService", "description": "Intention : RETRIEVER retrieveVpnBgpRouteProfilesAssociatedWithService: class-level retriever API retrieveVpnBgpRouteProfilesAssociatedWithService on default instance rtPrfMgr of class topology.RouteProfileManager", "input": [ { "name": "body", "type": "object", "info": ": {\"servicePointer\": \"string\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "fields", "filter", "pageNumber", "pageSize", "servicePointer", "sortFields" ], "properties": { "servicePointer": { "type": "string", "description": " The service FDN to search for" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "fields": { "type": "array", "description": " Sorting fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for RouteProfileManager.retrieveVpnBgpRouteProfilesAssociatedWithService to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyRouteProfileManagerRetrieveVpnBgpRouteProfilesAssociatedWithService" }, "task": true }, { "name": "restTopologyRouterFindAllCheckpoints", "summary": "findAllCheckpoints", "description": "Find all the checkpoints that exist for this checkpointable object. Intention : RETRIEVER findAllCheckpoints: instance-level [object finder] (retriever) API findAllCheckpoints of class topology.Router instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restTopologyRouterFindAllCheckpoints" }, "task": true }, { "name": "restTopologyRoutingAlarmManagerGetRoutingAlarmTypes", "summary": "getRoutingAlarmTypes", "description": "Intention : RETRIEVER getRoutingAlarmTypes: class-level retriever API getRoutingAlarmTypes on default instance tpgy-rtr-alarm-mgr of class topology.RoutingAlarmManager", "input": [ { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restTopologyRoutingAlarmManagerGetRoutingAlarmTypes" }, "task": true }, { "name": "restTopologyServiceBgpImpactAnalysisTimeRangeGetRdRtPairings", "summary": "getRdRtPairings", "description": "Intention : RETRIEVER getRdRtPairings: instance-level retriever API getRdRtPairings of class topology.ServiceBgpImpactAnalysisTimeRange instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restTopologyServiceBgpImpactAnalysisTimeRangeGetRdRtPairings" }, "task": true }, { "name": "restTopologySubnetFindAllCheckpoints", "summary": "findAllCheckpoints", "description": "Find all the checkpoints that exist for this checkpointable object. Intention : RETRIEVER findAllCheckpoints: instance-level [object finder] (retriever) API findAllCheckpoints of class topology.Subnet DescendantInfo: topology.IsisSubnet DescendantInfo: topology.OspfSubnet DescendantInfo: topology.NonRoutedSubnet instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restTopologySubnetFindAllCheckpoints" }, "task": true }, { "name": "restTopologyTopologyManagerConstrainedShortestPathFirstGraphExt", "summary": "constrainedShortestPathFirstGraphExt", "description": "Performs a constrained shortest path (CSPF) calculation from the given source to the given destination, using the given constraints, as known by the specified IGP protocol. Intention : RETRIEVER constrainedShortestPathFirstGraphExt: class-level retriever API constrainedShortestPathFirstGraphExt on default instance tpgy-mgr of class topology.TopologyManager The constrained shortest path graph.", "input": [ { "name": "body", "type": "object", "info": ": {\"igpAdminDomain\": \"string\", \"protocol\": \"string\", \"source\": \"string\", \"destType\": \"string\", \"dest\": \"string\", \"destLen\": 123, \"constraints\": {\"objectClassName\": \"string\", \"requiredBandwidth\": 123, \"includedAdminGroups\": 123, \"srlg\": \"array\", \"excludedAdminGroups\": 123, \"hopLimit\": 123, \"excludedRouters\": \"array\", \"excludedEgressLinks\": \"array\", \"useTeMetric\": \"boolean\", \"diffServClassType\": 123, \"setupPriority\": 123, \"holdPriority\": 123, \"requestType\": 123, \"leastFillMinThreshold\": 123}}", "required": false, "schema": { "type": "object", "required": [ "constraints", "dest", "destLen", "destType", "igpAdminDomain", "protocol", "source" ], "properties": { "igpAdminDomain": { "type": "string", "description": " The IGP Admin Domain ({{topology.AutonomousSystem}}) to perform the CSPF in." }, "protocol": { "type": "string", "description": " The protocol to run CSPF on. Only OSPF and ISIS aresupported." }, "source": { "type": "string", "description": " The source address. The format ofthe source is based on the sourceType property." }, "destType": { "type": "string", "description": " The address type of the destination. Currently only ipv4 issupported." }, "dest": { "type": "string", "description": " The destination address. The format ofthe destination is based on the destType property." }, "destLen": { "type": "integer", "description": " The length of the destination address. Its valid valuesdepend on the destType." }, "constraints": { "type": "object", "required": [ "diffServClassType", "excludedAdminGroups", "excludedEgressLinks", "excludedRouters", "holdPriority", "hopLimit", "includedAdminGroups", "leastFillMinThreshold", "objectClassName", "requestType", "requiredBandwidth", "setupPriority", "srlg", "useTeMetric" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "requiredBandwidth": { "type": "integer" }, "includedAdminGroups": { "type": "integer" }, "srlg": { "type": "array", "uniqueItems": true, "items": { "type": "integer" } }, "excludedAdminGroups": { "type": "integer" }, "hopLimit": { "type": "integer" }, "excludedRouters": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "excludedEgressLinks": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "useTeMetric": { "type": "boolean", "default": false }, "diffServClassType": { "type": "integer" }, "setupPriority": { "type": "integer" }, "holdPriority": { "type": "integer" }, "requestType": { "type": "integer" }, "leastFillMinThreshold": { "type": "integer" } }, "description": "Model containing the method level model for struct Constraints. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for TopologyManager.constrainedShortestPathFirstGraphExt to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyTopologyManagerConstrainedShortestPathFirstGraphExt" }, "task": true }, { "name": "restTopologyTopologyManagerHighlightLFANextHops", "summary": "highlightLFANextHops", "description": "Performs a LFA calculation from the given source to the given destination, using both OSPF and ISIS protocols (or both) as necessary Intention : RETRIEVER highlightLFANextHops: class-level retriever API highlightLFANextHops on default instance tpgy-mgr of class topology.TopologyManager The shortest path graph.", "input": [ { "name": "body", "type": "object", "info": ": {\"igpAdminDomain\": \"string\", \"protocol\": \"string\", \"sourceType\": \"string\", \"source\": \"string\", \"sourceLen\": 123, \"destType\": \"string\", \"dest\": \"string\", \"destLen\": 123}", "required": false, "schema": { "type": "object", "required": [ "dest", "destLen", "destType", "igpAdminDomain", "protocol", "source", "sourceLen", "sourceType" ], "properties": { "igpAdminDomain": { "type": "string", "description": " The IGP Admin Domain ({{topology.AutonomousSystem}}) to perform the LFA in." }, "protocol": { "type": "string", "description": " The protocol to run LFA on. Currently OSPF, OSPFv3 and ISIS aresupported." }, "sourceType": { "type": "string", "description": " The address type of the source. Currently only ipv4 issupported." }, "source": { "type": "string", "description": " The source address. The format ofthe source is based on the sourceType property." }, "sourceLen": { "type": "integer", "description": " The length of the source address. Its valid values dependon the sourceType." }, "destType": { "type": "string", "description": " The address type of the destination. Currently ipv4 and ipv6 aresupported." }, "dest": { "type": "string", "description": " The destination address. The format ofthe destination is based on the destType property." }, "destLen": { "type": "integer", "description": " The length of the destination address. Its valid valuesdepend on the destType." } }, "description": "Model containing the method level model for TopologyManager.highlightLFANextHops to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyTopologyManagerHighlightLFANextHops" }, "task": true }, { "name": "restTopologyTopologyManagerIgpShortestPathFirstGraphExt", "summary": "igpShortestPathFirstGraphExt", "description": "Performs a shortest path calculation from the given source to the given destination, using both OSPF and ISIS protocols (or both) as necessary. Intention : RETRIEVER igpShortestPathFirstGraphExt: class-level retriever API igpShortestPathFirstGraphExt on default instance tpgy-mgr of class topology.TopologyManager The shortest path graph.", "input": [ { "name": "body", "type": "object", "info": ": {\"igpAdminDomain\": \"string\", \"sourceType\": \"string\", \"source\": \"string\", \"sourceLen\": 123, \"destType\": \"string\", \"dest\": \"string\", \"destLen\": 123}", "required": false, "schema": { "type": "object", "required": [ "dest", "destLen", "destType", "igpAdminDomain", "source", "sourceLen", "sourceType" ], "properties": { "igpAdminDomain": { "type": "string", "description": " The IGP Admin Domain ({{topology.AutonomousSystem}}) to perform the SPF in." }, "sourceType": { "type": "string", "description": " The address type of the source. Currently only ipv4 issupported." }, "source": { "type": "string", "description": " The source address of the managed route. The format ofthe source is based on the sourceType property." }, "sourceLen": { "type": "integer", "description": " The length of the source address. Its valid values dependon the sourceType." }, "destType": { "type": "string", "description": " The address type of the destination. Currently only ipv4 issupported." }, "dest": { "type": "string", "description": " The destination address of the managed route. The format ofthe destination is based on the destType property." }, "destLen": { "type": "integer", "description": " The length of the destination address. Its valid valuesdepend on the destType." } }, "description": "Model containing the method level model for TopologyManager.igpShortestPathFirstGraphExt to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyTopologyManagerIgpShortestPathFirstGraphExt" }, "task": true }, { "name": "restTopologyTopologyManagerIgpShortestPathFirstGraphSet", "summary": "igpShortestPathFirstGraphSet", "description": "Performs a shortest path calculation from the given source (routerId, ipv4 or ipv6 prefix) to the given destination (routerId, ipv4 or ipv6 prefix), using both OSPF and ISIS protocols (or both) as necessary. Intention : RETRIEVER igpShortestPathFirstGraphSet: class-level retriever API igpShortestPathFirstGraphSet on default instance tpgy-mgr of class topology.TopologyManager The set of shortest path graph.", "input": [ { "name": "body", "type": "object", "info": ": {\"igpAdminDomain\": \"string\", \"sourceType\": \"string\", \"source\": \"string\", \"sourceLen\": 123, \"destType\": \"string\", \"dest\": \"string\", \"destLen\": 123}", "required": false, "schema": { "type": "object", "required": [ "dest", "destLen", "destType", "igpAdminDomain", "source", "sourceLen", "sourceType" ], "properties": { "igpAdminDomain": { "type": "string", "description": " The IGP Admin Domain ({{topology.AutonomousSystem}}) to perform the SPF in." }, "sourceType": { "type": "string", "description": " The address type of the source. Currently ipv4 and ipv6 aresupported." }, "source": { "type": "string", "description": " The source address of the managed route. The format ofthe source is based on the sourceType property." }, "sourceLen": { "type": "integer", "description": " The length of the source address. Its valid values dependon the sourceType." }, "destType": { "type": "string", "description": " The address type of the destination. Currently only ipv4 issupported." }, "dest": { "type": "string", "description": " The destination address of the managed route. The format ofthe destination is based on the destType property." }, "destLen": { "type": "integer", "description": " The length of the destination address. Its valid valuesdepend on the destType." } }, "description": "Model containing the method level model for TopologyManager.igpShortestPathFirstGraphSet to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyTopologyManagerIgpShortestPathFirstGraphSet" }, "task": true }, { "name": "restTopologyTopologyManagerNextHopExt", "summary": "nextHopExt", "description": "Calculates the next hop from all routers in the source set to the given destination FEC. Intention : RETRIEVER nextHopExt: class-level retriever API nextHopExt on default instance tpgy-mgr of class topology.TopologyManager The next hops, in the form of shortest path graphs, one for each source.", "input": [ { "name": "body", "type": "object", "info": ": {\"igpAdminDomain\": \"string\", \"protocols\": \"array\", \"sources\": [{\"objectClassName\": \"string\", \"sourceType\": \"string\", \"source\": \"string\"}], \"destType\": \"string\", \"dest\": \"string\", \"destLen\": 123}", "required": false, "schema": { "type": "object", "required": [ "dest", "destLen", "destType", "igpAdminDomain", "protocols", "sources" ], "properties": { "igpAdminDomain": { "type": "string", "description": " The IGP Admin Domain ({{topology.AutonomousSystem}}) to perform the next hop query in." }, "protocols": { "type": "array", "description": " The set of protocols to consider.", "items": { "type": "string" } }, "sources": { "type": "array", "description": " The set of source routers from which to calculate the nexthop.", "uniqueItems": true, "items": { "type": "object", "required": [ "objectClassName", "source", "sourceType" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "sourceType": { "type": "string" }, "source": { "type": "string" } }, "description": "Model containing the method level model for struct SourceParam. to decode json data to internal NFM-P object model" } }, "destType": { "type": "string", "description": " The address type of the destination. Currently only ipv4 issupported." }, "dest": { "type": "string", "description": " The destination address of the managed route. The format ofthe destination is based on the destType property." }, "destLen": { "type": "integer", "description": " The length of the destination address. Its valid valuesdepend on the destType." } }, "description": "Model containing the method level model for TopologyManager.nextHopExt to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyTopologyManagerNextHopExt" }, "task": true }, { "name": "restTopologyTopologyManagerRetrieveBgpEventsFilter", "summary": "retrieveBgpEventsFilter", "description": "Retrieve Historical BGP Event data from database Intention : RETRIEVER retrieveBgpEventsFilter: instance-level retriever API retrieveBgpEventsFilter on default instance tpgy-mgr of class topology.TopologyManager", "input": [ { "name": "body", "type": "object", "info": ": {\"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"fields\": \"array\", \"sortFields\": \"array\", \"filterInfo\": \"object\", \"pageNumber\": 123, \"pageSize\": 123, \"fullClassName\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "fields", "filter", "filterInfo", "fullClassName", "pageNumber", "pageSize", "sortFields" ], "properties": { "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "fields": { "type": "array", "description": " Sorting fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "filterInfo": { "type": "object", "description": " Filter info can be any of the following:BgpEventRetrievalFilter - To search specifically for BGP prefix eventsVprnBgpEventRetrievalFilter - To search for DC Prefix VPRN service related events" }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" }, "fullClassName": { "type": "string", "description": " The full class name to search for: topology.AbstractBgpEventStruct | topology.BgpPrefixEventStruct | topology.BgpDcEventStructtopology.AbstractBgpEventStruct will return all sub classes but only common properties" } }, "description": "Model containing the method level model for TopologyManager.retrieveBgpEventsFilter to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyTopologyManagerRetrieveBgpEventsFilter" }, "task": true }, { "name": "restTopologyTopologyManagerRetrieveBgpPrefixList", "summary": "rest_topology_TopologyManager_retrieveBgpPrefixList", "description": "rest_topology_TopologyManager_retrieveBgpPrefixList", "input": [ { "name": "body", "type": "object", "info": ": {\"bgpAs\": \"string\", \"bgpPrefixFilter\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "bgpAs", "bgpPrefixFilter" ], "properties": { "bgpAs": { "type": "string", "description": " The BGP AS ({{topology.BgpAutonomousSystem}}) to retrieve the prefixes." }, "bgpPrefixFilter": { "type": "string", "description": " The Filter ({{topology.BgpPrefixListFilter}}) to be applied for the retrieval." } }, "description": "Model containing the method level model for TopologyManager.retrieveBgpPrefixList to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyTopologyManagerRetrieveBgpPrefixList" }, "task": true }, { "name": "restTopologyTopologyManagerRetrieveIgpPrefixList", "summary": "rest_topology_TopologyManager_retrieveIgpPrefixList", "description": "rest_topology_TopologyManager_retrieveIgpPrefixList", "input": [ { "name": "body", "type": "object", "info": ": {\"igpAdminDomain\": \"string\", \"igpPrefixFilter\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "igpAdminDomain", "igpPrefixFilter" ], "properties": { "igpAdminDomain": { "type": "string", "description": " The IGP Admin Domain ({{topology.AutonomousSystem}}) to retrieve the prefixes." }, "igpPrefixFilter": { "type": "string", "description": " The Filter ({{topology.IgpPrefixListFilter}}) to be applied for the retrieval." } }, "description": "Model containing the method level model for TopologyManager.retrieveIgpPrefixList to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyTopologyManagerRetrieveIgpPrefixList" }, "task": true }, { "name": "restTopologyTopologyManagerRetrieveProfiledBgpEventsFilter", "summary": "retrieveProfiledBgpEventsFilter", "description": "Retrieve Historical BGP Event data from database Intention : RETRIEVER retrieveProfiledBgpEventsFilter: instance-level retriever API retrieveProfiledBgpEventsFilter on default instance tpgy-mgr of class topology.TopologyManager", "input": [ { "name": "body", "type": "object", "info": ": {\"filterInfo\": \"object\", \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "fields", "filter", "filterInfo", "pageNumber", "pageSize", "sortFields" ], "properties": { "filterInfo": { "type": "object", "description": " Pass in type topology.BgpProfileEventRetrievalFilter - To search specifically for BGP prefix events mapping to the profile" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "fields": { "type": "array", "description": " Sorting fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for TopologyManager.retrieveProfiledBgpEventsFilter to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyTopologyManagerRetrieveProfiledBgpEventsFilter" }, "task": true }, { "name": "restTopologyTopologyManagerRetrieveProfiledBgpPrefixList", "summary": "rest_topology_TopologyManager_retrieveProfiledBgpPrefixList", "description": "rest_topology_TopologyManager_retrieveProfiledBgpPrefixList", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restTopologyTopologyManagerRetrieveProfiledBgpPrefixList" }, "task": true }, { "name": "restTopologyTopologyManagerRetrieveServiceBgpInfo", "summary": "retrieveServiceBgpInfo", "description": "This method will retrieve BGP related information for a provided service FDN Intention : RETRIEVER retrieveServiceBgpInfo: class-level retriever API retrieveServiceBgpInfo on default instance tpgy-mgr of class topology.TopologyManager", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restTopologyTopologyManagerRetrieveServiceBgpInfo" }, "task": true }, { "name": "restTopologyTopologyManagerShortestPathFirstGraphExt", "summary": "shortestPathFirstGraphExt", "description": "Performs a shortest path calculation from the given source to the given destination, as known by the specified IGP protocol. Intention : RETRIEVER shortestPathFirstGraphExt: class-level retriever API shortestPathFirstGraphExt on default instance tpgy-mgr of class topology.TopologyManager The shortest path graph.", "input": [ { "name": "body", "type": "object", "info": ": {\"igpAdminDomain\": \"string\", \"protocol\": \"string\", \"sourceType\": \"string\", \"source\": \"string\", \"sourceLen\": 123, \"destType\": \"string\", \"dest\": \"string\", \"destLen\": 123}", "required": false, "schema": { "type": "object", "required": [ "dest", "destLen", "destType", "igpAdminDomain", "protocol", "source", "sourceLen", "sourceType" ], "properties": { "igpAdminDomain": { "type": "string", "description": " The IGP Admin Domain ({{topology.AutonomousSystem}}) to perform the SPF in." }, "protocol": { "type": "string", "description": " The protocol to run SPF on. Currently OSPF, OSPFv3 and ISIS aresupported." }, "sourceType": { "type": "string", "description": " The address type of the source. Currently only ipv4 issupported." }, "source": { "type": "string", "description": " The source address. The format ofthe source is based on the sourceType property." }, "sourceLen": { "type": "integer", "description": " The length of the source address. Its valid values dependon the sourceType." }, "destType": { "type": "string", "description": " The address type of the destination. Currently ipv4 and ipv6 aresupported." }, "dest": { "type": "string", "description": " The destination address. The format ofthe destination is based on the destType property." }, "destLen": { "type": "integer", "description": " The length of the destination address. Its valid valuesdepend on the destType." } }, "description": "Model containing the method level model for TopologyManager.shortestPathFirstGraphExt to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyTopologyManagerShortestPathFirstGraphExt" }, "task": true }, { "name": "restTopologyTopologyManagerShortestPathFirstGraphSet", "summary": "shortestPathFirstGraphSet", "description": "Performs a shortest path calculation from a given source (routerId, Ipv4 prefix, or Ipv6 prefix) to a given destination(routerId, Ipv4 prefix, or Ipv6 prefix), as known by the specified IGP protocol. Intention : RETRIEVER shortestPathFirstGraphSet: class-level retriever API shortestPathFirstGraphSet on default instance tpgy-mgr of class topology.TopologyManager The set of shortest path graph.", "input": [ { "name": "body", "type": "object", "info": ": {\"igpAdminDomain\": \"string\", \"protocol\": \"string\", \"sourceType\": \"string\", \"source\": \"string\", \"sourceLen\": 123, \"destType\": \"string\", \"dest\": \"string\", \"destLen\": 123}", "required": false, "schema": { "type": "object", "required": [ "dest", "destLen", "destType", "igpAdminDomain", "protocol", "source", "sourceLen", "sourceType" ], "properties": { "igpAdminDomain": { "type": "string", "description": " The IGP Admin Domain ({{topology.AutonomousSystem}}) to perform the SPF in." }, "protocol": { "type": "string", "description": " The protocol to run SPF on. Currently OSPF, OSPFv3 and ISIS aresupported." }, "sourceType": { "type": "string", "description": " The address type of the source. Currently ipv4 and ipv6 aresupported." }, "source": { "type": "string", "description": " The source address. The format ofthe source is based on the sourceType property." }, "sourceLen": { "type": "integer", "description": " The length of the source address. Its valid values dependon the sourceType." }, "destType": { "type": "string", "description": " The address type of the destination. Currently ipv4 and ipv6 aresupported." }, "dest": { "type": "string", "description": " The destination address. The format ofthe destination is based on the destType property." }, "destLen": { "type": "integer", "description": " The length of the destination address. Its valid valuesdepend on the destType." } }, "description": "Model containing the method level model for TopologyManager.shortestPathFirstGraphSet to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyTopologyManagerShortestPathFirstGraphSet" }, "task": true }, { "name": "restTopologyTopologyManagerUpdateBgpAsTopology", "summary": "rest_topology_TopologyManager_updateBgpAsTopology", "description": "rest_topology_TopologyManager_updateBgpAsTopology", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restTopologyTopologyManagerUpdateBgpAsTopology" }, "task": true }, { "name": "restTopologyTopologyManagerUpdateBgpRibInfo", "summary": "rest_topology_TopologyManager_updateBgpRibInfo", "description": "rest_topology_TopologyManager_updateBgpRibInfo", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restTopologyTopologyManagerUpdateBgpRibInfo" }, "task": true }, { "name": "restTopologyTopologyManagerUpdateBgpRouteTargets", "summary": "rest_topology_TopologyManager_updateBgpRouteTargets", "description": "rest_topology_TopologyManager_updateBgpRouteTargets", "input": [ { "name": "body", "type": "object", "info": ": {\"cpaa\": \"string\", \"vpnType\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "cpaa", "vpnType" ], "properties": { "cpaa": { "type": "string", "description": " The management IP address of the CPAA." }, "vpnType": { "type": "string", "description": " The the type of VPN for the Cpaa to retieve. Right now, IPv4 and L2 VPN only." } }, "description": "Model containing the method level model for TopologyManager.updateBgpRouteTargets to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyTopologyManagerUpdateBgpRouteTargets" }, "task": true }, { "name": "restTopologyTopologyManagerUpdateTopology", "summary": "rest_topology_TopologyManager_updateTopology", "description": "rest_topology_TopologyManager_updateTopology", "input": [ { "name": "body", "type": "object", "info": ": {\"protocol\": \"string\", \"cpaa\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "cpaa", "protocol" ], "properties": { "protocol": { "type": "string", "description": " The protocol to retrieve" }, "cpaa": { "type": "string", "description": " The management IP address of the CPAA." } }, "description": "Model containing the method level model for TopologyManager.updateTopology to decode json data to internal NFM-P object model" } } ], "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": "/restTopologyTopologyManagerUpdateTopology" }, "task": true }, { "name": "restTopologysimIgpTopologyModelImportAllPathMonitors", "summary": "rest_topologysim_IgpTopologyModel_importAllPathMonitors", "description": "rest_topologysim_IgpTopologyModel_importAllPathMonitors", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restTopologysimIgpTopologyModelImportAllPathMonitors" }, "task": true }, { "name": "restTopologysimIgpTopologyModelImportCheckpoint", "summary": "rest_topologysim_IgpTopologyModel_importCheckpoint", "description": "rest_topologysim_IgpTopologyModel_importCheckpoint", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restTopologysimIgpTopologyModelImportCheckpoint" }, "task": true }, { "name": "restTopologysimIgpTopologyModelImportFromIgpAdminDomain", "summary": "rest_topologysim_IgpTopologyModel_importFromIgpAdminDomain", "description": "rest_topologysim_IgpTopologyModel_importFromIgpAdminDomain", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"igpProtocols\": \"array\", \"igpAdminDomain\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "igpAdminDomain", "igpProtocols" ], "properties": { "igpProtocols": { "type": "array", "description": " The IGP protocols.", "items": { "type": "string" } }, "igpAdminDomain": { "type": "string", "description": " The IGP admin domain pointer." } }, "description": "Model containing the method level model for IgpTopologyModel.importFromIgpAdminDomain to decode json data to internal NFM-P object model" } } ], "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": "/restTopologysimIgpTopologyModelImportFromIgpAdminDomain" }, "task": true }, { "name": "restTopologysimIgpTopologyModelImportFromScenario", "summary": "rest_topologysim_IgpTopologyModel_importFromScenario", "description": "rest_topologysim_IgpTopologyModel_importFromScenario", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restTopologysimIgpTopologyModelImportFromScenario" }, "task": true }, { "name": "restTopologysimIgpTopologyModelImportIsisRoutingDomain", "summary": "rest_topologysim_IgpTopologyModel_importIsisRoutingDomain", "description": "rest_topologysim_IgpTopologyModel_importIsisRoutingDomain", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"cpaa\": \"string\", \"level\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "cpaa", "level" ], "properties": { "cpaa": { "type": "string", "description": " The pointer to the CPAA." }, "level": { "type": "string", "description": " The ISIS level." } }, "description": "Model containing the method level model for IgpTopologyModel.importIsisRoutingDomain to decode json data to internal NFM-P object model" } } ], "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": "/restTopologysimIgpTopologyModelImportIsisRoutingDomain" }, "task": true }, { "name": "restTopologysimIgpTopologyModelImportOspfArea", "summary": "rest_topologysim_IgpTopologyModel_importOspfArea", "description": "rest_topologysim_IgpTopologyModel_importOspfArea", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restTopologysimIgpTopologyModelImportOspfArea" }, "task": true }, { "name": "restTopologysimIgpTopologyModelImportPathMonitors", "summary": "rest_topologysim_IgpTopologyModel_importPathMonitors", "description": "rest_topologysim_IgpTopologyModel_importPathMonitors", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restTopologysimIgpTopologyModelImportPathMonitors" }, "task": true }, { "name": "restTopologysimIpPathRecordFindServices", "summary": "findServices", "description": "Find all the associated Services with an IP path record. Intention : RETRIEVER findServices: instance-level [object finder] (retriever) API findServices of class topologysim.IpPathRecord instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectType\": 123, \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "fields", "filter", "objectType", "pageNumber", "pageSize", "sortFields" ], "properties": { "objectType": { "type": "integer", "description": " " }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "fields": { "type": "array", "description": " Sorting fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for IpPathRecord.findServices to decode json data to internal NFM-P object model" } } ], "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": "/restTopologysimIpPathRecordFindServices" }, "task": true }, { "name": "restTopologysimLspPathRecordFindServices", "summary": "findServices", "description": "Find all the associated Services with a path monitor. Intention : RETRIEVER findServices: instance-level [object finder] (retriever) API findServices of class topologysim.LspPathRecord instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"objectType\": 123, \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}, \"fields\": \"array\", \"sortFields\": \"array\", \"pageNumber\": 123, \"pageSize\": 123}", "required": false, "schema": { "type": "object", "required": [ "fields", "filter", "objectType", "pageNumber", "pageSize", "sortFields" ], "properties": { "objectType": { "type": "integer", "description": " " }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" }, "fields": { "type": "array", "description": " Sorting fields", "uniqueItems": true, "items": { "type": "string" } }, "sortFields": { "type": "array", "description": " Sorting fields", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "description": " Page number" }, "pageSize": { "type": "integer", "description": " The number of entries to return" } }, "description": "Model containing the method level model for IpPathRecord.findServices to decode json data to internal NFM-P object model" } } ], "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": "/restTopologysimLspPathRecordFindServices" }, "task": true }, { "name": "restTopologysimMplsModelImportAllLsps", "summary": "rest_topologysim_MplsModel_importAllLsps", "description": "rest_topologysim_MplsModel_importAllLsps", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restTopologysimMplsModelImportAllLsps" }, "task": true }, { "name": "restTopologysimMplsModelImportAllRealLsps", "summary": "rest_topologysim_MplsModel_importAllRealLsps", "description": "rest_topologysim_MplsModel_importAllRealLsps", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restTopologysimMplsModelImportAllRealLsps" }, "task": true }, { "name": "restTopologysimMplsModelImportRealLsps", "summary": "rest_topologysim_MplsModel_importRealLsps", "description": "rest_topologysim_MplsModel_importRealLsps", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restTopologysimMplsModelImportRealLsps" }, "task": true }, { "name": "restTopologysimMplsModelImportSimulatedLsps", "summary": "rest_topologysim_MplsModel_importSimulatedLsps", "description": "rest_topologysim_MplsModel_importSimulatedLsps", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restTopologysimMplsModelImportSimulatedLsps" }, "task": true }, { "name": "restTpsperfTPSPMPolicyFindTPSs", "summary": "findTPSs", "description": "Find all managed TPSs for the specified Performance Management polling policy assigned. Intention : RETRIEVER findTPSs: class-level [object finder] (retriever) API findTPSs of class tpsperf.TPSPMPolicy DescendantInfo: tpsperf.TPSOSUPMPolicy", "input": [ { "name": "policyId", "type": "number", "info": ": 123", "required": false, "schema": { "title": "policyId", "type": "number" } } ], "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": "/restTpsperfTPSPMPolicyFindTPSs" }, "task": true }, { "name": "restTunnelmgmtRuleBasedGroupAddMember", "summary": "rest_tunnelmgmt_RuleBasedGroup_addMember", "description": "rest_tunnelmgmt_RuleBasedGroup_addMember", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInMemberFdn\": \"string\", \"aInPosition\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInMemberFdn": { "type": "string" }, "aInPosition": { "type": "integer" } }, "description": "Model containing the method level model for RuleBasedGroup.addMember to decode json data to internal NFM-P object model" } } ], "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": "/restTunnelmgmtRuleBasedGroupAddMember" }, "task": true }, { "name": "restTunnelmgmtRuleBasedGroupFindPotentialMembersIfg", "summary": "findPotentialMembersIfg", "description": "Find members that potentially can be added to this group. Intention : RETRIEVER findPotentialMembersIfg: instance-level [object finder] (retriever) API findPotentialMembersIfg of class tunnelmgmt.RuleBasedGroup DescendantInfo: tunnelmgmt.RuleBasedNeGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restTunnelmgmtRuleBasedGroupFindPotentialMembersIfg" }, "task": true }, { "name": "restTunnelmgmtRuleBasedGroupRemoveMember", "summary": "rest_tunnelmgmt_RuleBasedGroup_removeMember", "description": "rest_tunnelmgmt_RuleBasedGroup_removeMember", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restTunnelmgmtRuleBasedGroupRemoveMember" }, "task": true }, { "name": "restTunnelmgmtTopologyRuleApplyRule", "summary": "rest_tunnelmgmt_TopologyRule_applyRule", "description": "rest_tunnelmgmt_TopologyRule_applyRule", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restTunnelmgmtTopologyRuleApplyRule" }, "task": true }, { "name": "restTunnelmgmtTopologyRuleConvertOldDefinitions", "summary": "rest_tunnelmgmt_TopologyRule_convertOldDefinitions", "description": "rest_tunnelmgmt_TopologyRule_convertOldDefinitions", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restTunnelmgmtTopologyRuleConvertOldDefinitions" }, "task": true }, { "name": "restTunnelmgmtTopologyRuleDeleteCreatedTunnels", "summary": "rest_tunnelmgmt_TopologyRule_deleteCreatedTunnels", "description": "rest_tunnelmgmt_TopologyRule_deleteCreatedTunnels", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restTunnelmgmtTopologyRuleDeleteCreatedTunnels" }, "task": true }, { "name": "restTunnelmgmtTopologyRuleDeleteUnusedTunnels", "summary": "rest_tunnelmgmt_TopologyRule_deleteUnusedTunnels", "description": "rest_tunnelmgmt_TopologyRule_deleteUnusedTunnels", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restTunnelmgmtTopologyRuleDeleteUnusedTunnels" }, "task": true }, { "name": "restTunnelmgmtTopologyRuleFindCreatedTunnels", "summary": "findCreatedTunnels", "description": "Retrieves a list of tunnel elements created by the topologyrule. Should only be called on a main topology rule and not on one of the sub-topology rules. Intention : RETRIEVER findCreatedTunnels: instance-level [object finder] (retriever) API findCreatedTunnels of class tunnelmgmt.TopologyRule DescendantInfo: tunnelmgmt.HubAndSpokeTopologyRule DescendantInfo: tunnelmgmt.SpokeTopologyRule DescendantInfo: tunnelmgmt.ChainTopologyRule DescendantInfo: tunnelmgmt.SubTopologyRule Descen...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restTunnelmgmtTopologyRuleFindCreatedTunnels" }, "task": true }, { "name": "restTunnelmgmtTopologyRuleFindMissingTunnels", "summary": "findMissingTunnels", "description": "Retrieves a list of tunnel elements that are missing in the topology maintained by the topologyrule. Should only be called on a main topology rule and not on one of the sub-topology rules. Intention : MODIFIER findMissingTunnels: instance-level [object finder] (modifier) API findMissingTunnels of class tunnelmgmt.TopologyRule DescendantInfo: tunnelmgmt.HubAndSpokeTopologyRule DescendantInfo: tunnelmgmt.SpokeTopologyRule DescendantInfo: tunnelmgmt.ChainTopologyRule DescendantInfo: ...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restTunnelmgmtTopologyRuleFindMissingTunnels" }, "task": true }, { "name": "restTunnelmgmtTopologyRuleImportNetwork", "summary": "rest_tunnelmgmt_TopologyRule_importNetwork", "description": "rest_tunnelmgmt_TopologyRule_importNetwork", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restTunnelmgmtTopologyRuleImportNetwork" }, "task": true }, { "name": "restUrlDecodeStringFramework", "summary": "framework decode", "description": "An API service to decode Query parameters. It can be used to show how Query parameters can be decoded. Developpers can use this interface to see the result of the decoded string as a query parameter.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": false, "schema": { "title": "instanceFullName", "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": "/restUrlDecodeStringFramework" }, "task": true }, { "name": "restUrlQueryFindInstance", "summary": "query", "description": "Test Query Parameter Decoding.\nAn API service to decode a query parameters. It can be used to show how query parameters can be decoded. Developpers can use this interface to see the result of the decoded string as a query parameter. The string being decoded can have many iterations.For example, the client makes the following HTTP request using a double ecoding string. See the encoding example:\n\n POST /v2/url/decode/queryparam?instanceFullName=XATzChm4-macsmgr%25253Aca-a%252B%252523%252Bb%252...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": false, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restUrlQueryFindInstance" }, "task": true }, { "name": "restUrlDecodeString", "summary": "decode", "description": "An API service to decode a path parameters. It can be used to show how path parameters can be decoded. Developpers can use this interface to see the result of the decoded string as a path parameter. The string being decoded can have many iterations.For example, the client makes the following HTTP request using a double ecoding string. See the encoding example:\n\n POST /v2/url/decode/XATzChm4-macsmgr%25253Aca-a%252B%252523%252Bb%252B%252525%252Bc%252B%252524%252Bd%252B%252521%252Be%252B%252526...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "number", "info": ": 123", "required": false, "schema": { "type": "integer" } } ], "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": "/restUrlDecodeString" }, "task": true }, { "name": "restUrlEncodeString", "summary": "encode", "description": "An API service to encode a path parameters. It can be used to show how path parameters can be encoded. Developpers can use this interface to see the result of the encoded string as a path parameter. The string being encoded can have many encoded iterations.For example, the client makes the following HTTP request:\n\n POST /v2/url/encode HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n {\n ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"stringToEncode\": \"string\", \"encodingIteration\": 123}", "required": false, "schema": { "type": "object", "properties": { "stringToEncode": { "type": "string", "example": "XATzChm4-macsmgr:ca-a # b % c $ d ! e & *:scak:psk-1", "description": "String" }, "encodingIteration": { "type": "integer", "example": "1", "description": "int" } }, "description": "URL in path parameters to model" } } ], "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": "/restUrlEncodeString" }, "task": true }, { "name": "restVllL2AccessInterfaceCreateDefaultTestHeadProfile", "summary": "createDefaultTestHeadProfile", "description": "Intention : MODIFIER createDefaultTestHeadProfile: instance-level [administrative creation] (modifier) API createDefaultTestHeadProfile of class vll.L2AccessInterface DescendantInfo: ipipe.L2AccessInterface instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restVllL2AccessInterfaceCreateDefaultTestHeadProfile" }, "task": true }, { "name": "restVllL2AccessInterfaceShutDown", "summary": "rest_vll_L2AccessInterface_shutDown", "description": "rest_vll_L2AccessInterface_shutDown", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restVllL2AccessInterfaceShutDown" }, "task": true }, { "name": "restVllL2AccessInterfaceSwitchToRedundantSaps", "summary": "switchToRedundantSaps", "description": "For each SAP in the specified list, NFM-P will copy over its configuration and create a new SAP on the backup port specified on it, and then it will be deleted. Intention : MODIFIER switchToRedundantSaps: class-level modifier API switchToRedundantSaps of class vll.L2AccessInterface DescendantInfo: ipipe.L2AccessInterface If succeed, null returned. If failed, a list of error messages will be returned.", "input": [ { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restVllL2AccessInterfaceSwitchToRedundantSaps" }, "task": true }, { "name": "restVllL2AccessInterfaceTurnUp", "summary": "rest_vll_L2AccessInterface_turnUp", "description": "rest_vll_L2AccessInterface_turnUp", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restVllL2AccessInterfaceTurnUp" }, "task": true }, { "name": "restVllVllFindDownstreamSdpBindings", "summary": "findDownstreamSdpBindings", "description": "Find the downstream sdp bindings in the VLL service starts from the passed in spoke sdp binding. Intention : RETRIEVER findDownstreamSdpBindings: class-level [object finder] (retriever) API findDownstreamSdpBindings of class vll.Vll DescendantInfo: hpipe.Hpipe DescendantInfo: ipipe.Ipipe DescendantInfo: fpipe.Fpipe DescendantInfo: cpipe.Cpipe DescendantInfo: apipe.Apipe DescendantInfo: epipe.Epipe", "input": [ { "name": "spokeSdpBindingFullName", "type": "string", "info": ": string", "required": false, "schema": { "title": "spokeSdpBindingFullName", "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": "/restVllVllFindDownstreamSdpBindings" }, "task": true }, { "name": "restVplsAbstractVplsDistributeServiceMacProtectionList", "summary": "rest_vpls_AbstractVpls_distributeServiceMacProtectionList", "description": "rest_vpls_AbstractVpls_distributeServiceMacProtectionList", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restVplsAbstractVplsDistributeServiceMacProtectionList" }, "task": true }, { "name": "restVplsAbstractVplsFindAssociatedEpipeSites", "summary": "findAssociatedEpipeSites", "description": "Return the list of the EPIPE sites which are associated with the backbone sites in this VPLS service. Intention : RETRIEVER findAssociatedEpipeSites: instance-level [object finder] (retriever) API findAssociatedEpipeSites of class vpls.AbstractVpls DescendantInfo: vpls.Vpls DescendantInfo: mvpls.Mvpls instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restVplsAbstractVplsFindAssociatedEpipeSites" }, "task": true }, { "name": "restVplsAbstractVplsFindAssociatedISites", "summary": "findAssociatedISites", "description": "Return the list of the I-VPLS sites which are associated with the backbone sites in this VPLS service. Intention : RETRIEVER findAssociatedISites: instance-level [object finder] (retriever) API findAssociatedISites of class vpls.AbstractVpls DescendantInfo: vpls.Vpls DescendantInfo: mvpls.Mvpls instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restVplsAbstractVplsFindAssociatedISites" }, "task": true }, { "name": "restVplsBgpCfgEvalPwTemplateAction", "summary": "rest_vpls_BgpCfg_evalPwTemplateAction", "description": "rest_vpls_BgpCfg_evalPwTemplateAction", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restVplsBgpCfgEvalPwTemplateAction" }, "task": true }, { "name": "restVplsEvpnSiteGetEVPNSites", "summary": "getEVPNSites", "description": "Gets the eVPN Service Sites for the DVRS Site Intention : RETRIEVER getEVPNSites: class-level retriever API getEVPNSites of class vpls.EvpnSite", "input": [ { "name": "aInDVRSSiteName", "type": "string", "info": ": string", "required": false, "schema": { "title": "aInDVRSSiteName", "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": "/restVplsEvpnSiteGetEVPNSites" }, "task": true }, { "name": "restVplsL2AccessInterfaceRequestClearIgmpHostTracking", "summary": "requestClearIgmpHostTracking", "description": "Request clearing of all IGMP Host Tracking information for this L2 AccessInterface. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearIgmpHostTracking: instance-level modifier API requestClearIgmpHostTracking of class vpls.L2AccessInterface Descenda...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restVplsL2AccessInterfaceRequestClearIgmpHostTracking" }, "task": true }, { "name": "restVplsMSapRequestClearMsap", "summary": "requestClearMsap", "description": "Request clearing of this MSAP. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearMsap: instance-level modifier API requestClearMsap of class vpls.MSap instanceFullName : distinguished/instance name of called object A request handle which allows the ...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restVplsMSapRequestClearMsap" }, "task": true }, { "name": "restVplsProxyArpNdMacListFindNumberOfAssociation", "summary": "findNumberOfAssociation", "description": "Return the number of MACs associated to this MAC list. Intention : RETRIEVER findNumberOfAssociation: class-level [object finder] (retriever) API findNumberOfAssociation of class vpls.ProxyArpNdMacList", "input": [ { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "macListName", "type": "string", "info": ": string", "required": false, "schema": { "title": "macListName", "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": "/restVplsProxyArpNdMacListFindNumberOfAssociation" }, "task": true }, { "name": "restVplsProxyArpNdMacListFindNumberOfMacs", "summary": "findNumberOfMacs", "description": "Return the number of MACs associated to this MAC list. Intention : RETRIEVER findNumberOfMacs: class-level [object finder] (retriever) API findNumberOfMacs of class vpls.ProxyArpNdMacList", "input": [ { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "macListName", "type": "string", "info": ": string", "required": false, "schema": { "title": "macListName", "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": "/restVplsProxyArpNdMacListFindNumberOfMacs" }, "task": true }, { "name": "restVplsSiteRequestClearIgmpHostTracking", "summary": "requestClearIgmpHostTracking", "description": "Request clearing of all IGMP Host Tracking information for this site. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearIgmpHostTracking: instance-level modifier API requestClearIgmpHostTracking of class vpls.Site instanceFullName : distinguished/in...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restVplsSiteRequestClearIgmpHostTracking" }, "task": true }, { "name": "restVplsSiteRequestClearProxyArpDups", "summary": "requestClearProxyArpDups", "description": "Request to clear the duplicate Proxy-ARP entrie(s) Intention : MODIFIER requestClearProxyArpDups: instance-level modifier API requestClearProxyArpDups of class vpls.Site instanceFullName : distinguished/instance name of called object A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restVplsSiteRequestClearProxyArpDups" }, "task": true }, { "name": "restVplsSiteRequestClearProxyArpDyn", "summary": "requestClearProxyArpDyn", "description": "Request to clear the dynamic Proxy-ARP entrie(s) Intention : MODIFIER requestClearProxyArpDyn: instance-level modifier API requestClearProxyArpDyn of class vpls.Site instanceFullName : distinguished/instance name of called object A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restVplsSiteRequestClearProxyArpDyn" }, "task": true }, { "name": "restVplsSiteRequestClearProxyNdDups", "summary": "requestClearProxyNdDups", "description": "Request to clear the duplicate Proxy-ND entrie(s) Intention : MODIFIER requestClearProxyNdDups: instance-level modifier API requestClearProxyNdDups of class vpls.Site instanceFullName : distinguished/instance name of called object A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restVplsSiteRequestClearProxyNdDups" }, "task": true }, { "name": "restVplsSiteRequestClearProxyNdDyn", "summary": "requestClearProxyNdDyn", "description": "Request to clear the dynamic Proxy-ND entrie(s) Intention : MODIFIER requestClearProxyNdDyn: instance-level modifier API requestClearProxyNdDyn of class vpls.Site instanceFullName : distinguished/instance name of called object A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restVplsSiteRequestClearProxyNdDyn" }, "task": true }, { "name": "restVplsVplsRestoreServiceForThroughputTest", "summary": "restoreServiceForThroughputTest", "description": "Restore the service from the throughput test. Intention : MODIFIER restoreServiceForThroughputTest: class-level modifier API restoreServiceForThroughputTest of class vpls.Vpls A list of error messages.", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restVplsVplsRestoreServiceForThroughputTest" }, "task": true }, { "name": "restVprnAbstractSiteRequestClearIgmpHostTracking", "summary": "requestClearIgmpHostTracking", "description": "Request clearing of all IGMP Host Tracking information for this site. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearIgmpHostTracking: instance-level modifier API requestClearIgmpHostTracking of class vprn.AbstractSite DescendantInfo: vprn.Site ...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restVprnAbstractSiteRequestClearIgmpHostTracking" }, "task": true }, { "name": "restVprnGroupInterfaceRequestPolicyAccountStatsClear", "summary": "requestPolicyAccountStatsClear", "description": "Request clearing of Policy Accounting Statistics on this interface. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestPolicyAccountStatsClear: instance-level modifier API requestPolicyAccountStatsClear of class vprn.GroupInterface instanceFullName : dist...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInAcctType\": 123, \"aInAcctIndex\": 123, \"aInClearAll\": \"boolean\"}", "required": false, "schema": { "type": "object", "properties": { "aInAcctType": { "type": "integer" }, "aInAcctIndex": { "type": "integer" }, "aInClearAll": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for NetworkInterface.requestPolicyAccountStatsClear to decode json data to internal NFM-P object model" } } ], "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": "/restVprnGroupInterfaceRequestPolicyAccountStatsClear" }, "task": true }, { "name": "restVprnL3AccessInterfaceRequestPolicyAccountStatsClear", "summary": "requestPolicyAccountStatsClear", "description": "Request clearing of Policy Accounting Statistics on this interface. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestPolicyAccountStatsClear: instance-level modifier API requestPolicyAccountStatsClear of class vprn.L3AccessInterface instanceFullName : d...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInAcctType\": 123, \"aInAcctIndex\": 123, \"aInClearAll\": \"boolean\"}", "required": false, "schema": { "type": "object", "properties": { "aInAcctType": { "type": "integer" }, "aInAcctIndex": { "type": "integer" }, "aInClearAll": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for NetworkInterface.requestPolicyAccountStatsClear to decode json data to internal NFM-P object model" } } ], "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": "/restVprnL3AccessInterfaceRequestPolicyAccountStatsClear" }, "task": true }, { "name": "restVprnMSapRequestClearMsap", "summary": "requestClearMsap", "description": "Request clearing of this MSAP. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearMsap: instance-level modifier API requestClearMsap of class vprn.MSap instanceFullName : distinguished/instance name of called object A request handle which allows the ...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restVprnMSapRequestClearMsap" }, "task": true }, { "name": "restVprnMSapRetrieveMsap", "summary": "retrieveMsap", "description": "Method used to retrieve MSAP information from the NFM-P database if the MSAP exists there, or return an empty MSAP object except for a populated serviceId retrieved from the network Intention : RETRIEVER retrieveMsap: class-level retriever API retrieveMsap of class vprn.MSap", "input": [ { "name": "body", "type": "object", "info": ": {\"subscrIdent\": \"string\", \"nodeId\": \"string\", \"portName\": \"string\", \"outerEncapValue\": 123, \"innerEncapValue\": 123, \"isActive\": \"boolean\", \"timeout\": 123, \"shallowRetrieval\": \"boolean\"}", "required": false, "schema": { "type": "object", "required": [ "innerEncapValue", "isActive", "nodeId", "outerEncapValue", "portName", "shallowRetrieval", "subscrIdent", "timeout" ], "properties": { "subscrIdent": { "type": "string", "description": " The subscriber ID used to determine the MSAP’s service IDin the event the MSAP cannot be found in the NFM-P database" }, "nodeId": { "type": "string", "description": " The site ID of the NE to query." }, "portName": { "type": "string", "description": " The port of the MSAP on which the subscriber is located.The string should be set to a value in the ‘Port x y z’ format." }, "outerEncapValue": { "type": "integer", "description": " The outer encapsulation of the MSAP on which the subscriber is located." }, "innerEncapValue": { "type": "integer", "description": " The inner encapsulation of the MSAP on which the subscriber is located" }, "isActive": { "type": "boolean", "description": " The value \"false\" means that the MSAP exists in NFM-P database but not on NE. default:true", "default": false }, "timeout": { "type": "integer", "description": " (Optional)The number of milliseconds to wait before receiving the results.If no results are received in the given time, the method returns. default:0" }, "shallowRetrieval": { "type": "boolean", "description": " (Optional)If it is true, not all of the properties are retrieved for quick response default:false", "default": false } }, "description": "Model containing the method level model for MSap.retrieveMsap to decode json data to internal NFM-P object model" } } ], "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": "/restVprnMSapRetrieveMsap" }, "task": true }, { "name": "restVprnServiceAccessPointRequestClearIgmpHostTracking", "summary": "requestClearIgmpHostTracking", "description": "Request clearing of all IGMP Host Tracking information for this ServiceAccessPoint. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearIgmpHostTracking: instance-level modifier API requestClearIgmpHostTracking of class vprn.ServiceAccessPoint Descend...(description truncated)", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "boolean", "info": ": boolean", "required": false, "schema": { "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": "/restVprnServiceAccessPointRequestClearIgmpHostTracking" }, "task": true }, { "name": "restVprnSiteGetExportRouteTargets", "summary": "getExportRouteTargets", "description": "The export route targets for this site Intention : RETRIEVER getExportRouteTargets: class-level retriever API getExportRouteTargets of class vprn.Site", "input": [ { "name": "siteName", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteName", "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": "/restVprnSiteGetExportRouteTargets" }, "task": true }, { "name": "restVprnSiteGetImportRouteTargets", "summary": "getImportRouteTargets", "description": "The import route targets for this site Intention : RETRIEVER getImportRouteTargets: class-level retriever API getImportRouteTargets of class vprn.Site", "input": [ { "name": "siteName", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteName", "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": "/restVprnSiteGetImportRouteTargets" }, "task": true }, { "name": "restVprnSiteRetrieveVRFRoutes", "summary": "retrieveVRFRoutes", "description": "FDN of the site FDN of the service. Prefix of the Hop in the route table. Method used to query the NE for VRF routes on a particular service. Intention : RETRIEVER retrieveVRFRoutes: class-level retriever API retrieveVRFRoutes of class vprn.Site", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteFdn\": \"string\", \"aInSvcFdn\": \"string\", \"aInSubnetWithLength\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInSiteFdn": { "type": "string" }, "aInSvcFdn": { "type": "string" }, "aInSubnetWithLength": { "type": "string" } }, "description": "Model containing the method level model for Site.retrieveVRFRoutes to decode json data to internal NFM-P object model" } } ], "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": "/restVprnSiteRetrieveVRFRoutes" }, "task": true }, { "name": "restVrrpAuthenticationKeyRemoveAuthenticationKey", "summary": "rest_vrrp_AuthenticationKey_removeAuthenticationKey", "description": "rest_vrrp_AuthenticationKey_removeAuthenticationKey", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restVrrpAuthenticationKeyRemoveAuthenticationKey" }, "task": true }, { "name": "restVrrpPolicyFindSrrpInstances", "summary": "findSrrpInstances", "description": "Intention : RETRIEVER findSrrpInstances: instance-level [object finder] (retriever) API findSrrpInstances of class vrrp.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restVrrpPolicyFindSrrpInstances" }, "task": true }, { "name": "restVrrpPolicyFindVrrpInstances", "summary": "findVrrpInstances", "description": "Intention : RETRIEVER findVrrpInstances: instance-level [object finder] (retriever) API findVrrpInstances of class vrrp.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restVrrpPolicyFindVrrpInstances" }, "task": true }, { "name": "restVrrpVrrpVirtualRouterAddVrrpInstances", "summary": "rest_vrrp_VrrpVirtualRouter_addVrrpInstances", "description": "rest_vrrp_VrrpVirtualRouter_addVrrpInstances", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restVrrpVrrpVirtualRouterAddVrrpInstances" }, "task": true }, { "name": "restVrrpVrrpVirtualRouterCreateVrrpInstance", "summary": "createVrrpInstance", "description": "creates a vrrp Instance and adds a VRInstance to this Virtual Router Backup address is automatically configured for this Instance. Intention : MODIFIER createVrrpInstance: instance-level [administrative creation] (modifier) API createVrrpInstance of class vrrp.VrrpVirtualRouter instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"aInL3InterfaceFullName\": \"string\", \"aInVrrpInstance\": {\"objectClassName\": \"string\", \"actionBitmask\": \"array\", \"containedClassProperties\": \"object\", \"relativeOrDistinguishedName\": \"string\", \"propertyValuePolicyMap\": \"object\", \"containmentInfo\": \"object\", \"vrId\": 123, \"owner\": 123, \"passive\": 123, \"macAddress\": \"string\", \"masterIntervalInherit\": 123, \"messageInterval\": 123, \"messageIntervalMilSec\": 123, \"pingReply\": 123, \"preempt\": 123, \"priority\": 123, \"sshReply\": 123, \"telnetReply\": 123, \"traceRouteReply\": 123, \"standByFwding\": 123, \"administrativeState\": 123, \"vrrpPolicyPointer\": \"string\", \"initDelay\": 123, \"bfdEnable\": \"boolean\", \"memberOperGroupName\": \"string\", \"memberOperGroupPtr\": \"string\", \"ntpReply\": \"boolean\", \"templateVersionPointer\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "aInL3InterfaceFullName": { "type": "string" }, "aInVrrpInstance": { "type": "object", "required": [ "actionBitmask", "containmentInfo", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } }, "containmentInfo": { "type": "object", "additionalProperties": { "type": "object", "required": [ "actionBitmask", "objectClassName", "propertyValuePolicyMap", "relativeOrDistinguishedName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "actionBitmask": { "type": "array", "items": { "type": "string" } }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "type": "object", "required": [ "objectClassName", "parameters", "policyFullName" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } }, "vrId": { "type": "integer" }, "owner": { "type": "integer" }, "passive": { "type": "integer" }, "macAddress": { "type": "string" }, "masterIntervalInherit": { "type": "integer" }, "messageInterval": { "type": "integer" }, "messageIntervalMilSec": { "type": "integer" }, "pingReply": { "type": "integer" }, "preempt": { "type": "integer" }, "priority": { "type": "integer" }, "sshReply": { "type": "integer" }, "telnetReply": { "type": "integer" }, "traceRouteReply": { "type": "integer" }, "standByFwding": { "type": "integer" }, "administrativeState": { "type": "integer" }, "vrrpPolicyPointer": { "type": "string" }, "initDelay": { "type": "integer" }, "bfdEnable": { "type": "boolean", "default": false }, "memberOperGroupName": { "type": "string" }, "memberOperGroupPtr": { "type": "string" }, "ntpReply": { "type": "boolean", "default": false }, "templateVersionPointer": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo AbstractInstanceConfigInfo. to decode json data to internal NFM-P object model" } }, "description": "Model containing the method level model for VrrpVirtualRouter.createVrrpInstance to decode json data to internal NFM-P object model" } } ], "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": "/restVrrpVrrpVirtualRouterCreateVrrpInstance" }, "task": true }, { "name": "restVrrpVrrpVirtualRouterFindInstances", "summary": "findInstances", "description": "finds vrrp Instances that have same vrId and that parent L3Interface has a Subnet which the backupAddress falls in Intention : RETRIEVER findInstances: class-level [object finder] (retriever) API findInstances of class vrrp.VrrpVirtualRouter", "input": [ { "name": "body", "type": "object", "info": ": {\"aInBackUpAddress\": \"string\", \"aInBackupAddressType\": 123, \"aInVrId\": 123, \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter" ], "properties": { "aInBackUpAddress": { "type": "string" }, "aInBackupAddressType": { "type": "integer" }, "aInVrId": { "type": "integer" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for VrrpVirtualRouter.findInstances to decode json data to internal NFM-P object model" } } ], "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": "/restVrrpVrrpVirtualRouterFindInstances" }, "task": true }, { "name": "restVrrpVrrpVirtualRouterFindL3Interfaces", "summary": "findL3Interfaces", "description": "finds L3Interface has a Subnet which the backupAddress falls in and does have a vrrp instance already created with passed in Vrid Intention : RETRIEVER findL3Interfaces: class-level [object finder] (retriever) API findL3Interfaces of class vrrp.VrrpVirtualRouter", "input": [ { "name": "body", "type": "object", "info": ": {\"aInBackUpAddress\": \"string\", \"aInBackupAddressType\": 123, \"aInVrId\": 123, \"filter\": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}}", "required": false, "schema": { "type": "object", "required": [ "filter" ], "properties": { "aInBackUpAddress": { "type": "string" }, "aInBackupAddressType": { "type": "integer" }, "aInVrId": { "type": "integer" }, "filter": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } }, "description": "Model containing the method level model for VrrpVirtualRouter.findL3Interfaces to decode json data to internal NFM-P object model" } } ], "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": "/restVrrpVrrpVirtualRouterFindL3Interfaces" }, "task": true }, { "name": "restVrrpVrrpVirtualRouterRemoveInstances", "summary": "rest_vrrp_VrrpVirtualRouter_removeInstances", "description": "rest_vrrp_VrrpVirtualRouter_removeInstances", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "array", "info": ": array", "required": false, "schema": { "type": "array", "items": { "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": "/restVrrpVrrpVirtualRouterRemoveInstances" }, "task": true }, { "name": "restVsPolicyFindAccessInterfaces", "summary": "findAccessInterfaces", "description": "Intention : RETRIEVER findAccessInterfaces: instance-level [object finder] (retriever) API findAccessInterfaces of class vs.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restVsPolicyFindAccessInterfaces" }, "task": true }, { "name": "restVsPolicyFindAggregationSchedulers", "summary": "findAggregationSchedulers", "description": "Intention : RETRIEVER findAggregationSchedulers: instance-level [object finder] (retriever) API findAggregationSchedulers of class vs.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restVsPolicyFindAggregationSchedulers" }, "task": true }, { "name": "restVsPolicyFindServiceIpInterfaces", "summary": "findServiceIpInterfaces", "description": "Intention : RETRIEVER findServiceIpInterfaces: instance-level [object finder] (retriever) API findServiceIpInterfaces of class vs.Policy instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"fullClassName\": \"string\", \"filterExpression\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "filterExpression", "fullClassName" ], "properties": { "fullClassName": { "type": "string", "example": "netw.NetworkElement", "description": "string" }, "filterExpression": { "type": "string", "example": "siteId = '1.1.1.1'", "description": "string" } }, "description": "Model containing the Data model for RestFilter" } } ], "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": "/restVsPolicyFindServiceIpInterfaces" }, "task": true }, { "name": "restVsPolicyGetDependency", "summary": "getDependency", "description": "Intention : RETRIEVER getDependency: class-level retriever API getDependency of class vs.Policy", "input": [ { "name": "objectName", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectName", "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": "/restVsPolicyGetDependency" }, "task": true }, { "name": "restVsPolicyGetDependencyCount", "summary": "getDependencyCount", "description": "Intention : RETRIEVER getDependencyCount: class-level retriever API getDependencyCount of class vs.Policy", "input": [ { "name": "objectName", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectName", "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": "/restVsPolicyGetDependencyCount" }, "task": true }, { "name": "restVwmperfVWMPMPolicyFindVWMs", "summary": "findVWMs", "description": "Find all managed VWMs for the specified Performance Management polling policy assigned. Intention : RETRIEVER findVWMs: class-level [object finder] (retriever) API findVWMs of class vwmperf.VWMPMPolicy DescendantInfo: vwmperf.OSUPMPolicy", "input": [ { "name": "policyId", "type": "number", "info": ": 123", "required": false, "schema": { "title": "policyId", "type": "number" } } ], "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": "/restVwmperfVWMPMPolicyFindVWMs" }, "task": true }, { "name": "restVwmsasPrbsTestCancelPrbsTestExection", "summary": "rest_vwmsas_PrbsTest_cancelPrbsTestExection", "description": "rest_vwmsas_PrbsTest_cancelPrbsTestExection", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restVwmsasPrbsTestCancelPrbsTestExection" }, "task": true }, { "name": "restWlangwGTPSessionRetrieveGtpSessions", "summary": "retrieveGtpSessions", "description": "Method used to retrieve GTP sessions from NE. Intention : RETRIEVER retrieveGtpSessions: class-level retriever API retrieveGtpSessions of class wlangw.GTPSession", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"imsi\": \"string\", \"apnNetwId\": \"string\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "apnNetwId", "imsi", "objectClassName", "siteId", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "imsi": { "type": "string" }, "apnNetwId": { "type": "string" }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct RetrGtpSessionStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restWlangwGTPSessionRetrieveGtpSessions" }, "task": true }, { "name": "restWlangwIsaPoolSubnetRequestClearIsaSubnets", "summary": "requestClearIsaSubnets", "description": "Request clearing the ISA Subnets with the specified parameters. The siteId is required. If svcId is not given, the method will use the base routing instance. If using any other optional parameters, either subscriberInterfaceName or ipAddress and prefix must be set. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of th...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"svcId\": 123, \"subscriberInterfaceName\": \"string\", \"ipAddress\": \"string\", \"prefix\": 123}", "required": false, "schema": { "type": "object", "required": [ "ipAddress", "objectClassName", "prefix", "siteId", "subscriberInterfaceName", "svcId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "svcId": { "type": "integer" }, "subscriberInterfaceName": { "type": "string" }, "ipAddress": { "type": "string" }, "prefix": { "type": "integer" } }, "description": "Model containing the method level model for struct ClearIsaSubnetStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restWlangwIsaPoolSubnetRequestClearIsaSubnets" }, "task": true }, { "name": "restWlangwIsaPoolSubnetRetrieveIsaPoolSubnets", "summary": "retrieveIsaPoolSubnets", "description": "Intention : RETRIEVER retrieveIsaPoolSubnets: class-level retriever API retrieveIsaPoolSubnets of class wlangw.IsaPoolSubnet", "input": [ { "name": "body", "type": "object", "info": ": {\"PoolSubnetRtrvStruct\": {\"objectClassName\": \"string\", \"vRouterId\": 123, \"siteId\": \"string\", \"subnetAddress\": \"string\", \"subnetPrefixLength\": 123}, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "PoolSubnetRtrvStruct": { "type": "object", "required": [ "objectClassName", "siteId", "subnetAddress", "subnetPrefixLength" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "vRouterId": { "type": "integer" }, "siteId": { "type": "string" }, "subnetAddress": { "type": "string" }, "subnetPrefixLength": { "type": "integer" } }, "description": "Model containing the method level model for struct PoolSubnetRtrvStruct. to decode json data to internal NFM-P object model" }, "timeout": { "type": "integer", "description": " (Optional) The number of milliseconds to wait beforereceiving the results. If the results are notreceived in the given time, the method returns. default:0" } }, "description": "Model containing the method level model for IsaPoolSubnet.retrieveIsaPoolSubnets to decode json data to internal NFM-P object model" } } ], "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": "/restWlangwIsaPoolSubnetRetrieveIsaPoolSubnets" }, "task": true }, { "name": "restWlangwMgwAddrMapRemoveMgwAddrMaps", "summary": "rest_wlangw_MgwAddrMap_removeMgwAddrMaps", "description": "rest_wlangw_MgwAddrMap_removeMgwAddrMaps", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/restWlangwMgwAddrMapRemoveMgwAddrMaps" }, "task": true }, { "name": "restWlangwWlanGwBdUeRetrieveWlanGwBdUesPerTunnel", "summary": "retrieveWlanGwBdUesPerTunnel", "description": "Method retrieve all User Equipments resides on the specified tunnel (Base or VPRN). Intention : RETRIEVER retrieveWlanGwBdUesPerTunnel: class-level retriever API retrieveWlanGwBdUesPerTunnel of class wlangw.WlanGwBdUe", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInTimeout\": 123, \"aInRouterId\": 123, \"aInRemoteAddr\": \"string\", \"aInLocalAddr\": \"string\", \"aInBridgeId\": 123, \"aInMacAddr\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInTimeout": { "type": "integer" }, "aInRouterId": { "type": "integer" }, "aInRemoteAddr": { "type": "string" }, "aInLocalAddr": { "type": "string" }, "aInBridgeId": { "type": "integer" }, "aInMacAddr": { "type": "string" } }, "description": "Model containing the method level model for WlanGwBdUe.retrieveWlanGwBdUesPerTunnel to decode json data to internal NFM-P object model" } } ], "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": "/restWlangwWlanGwBdUeRetrieveWlanGwBdUesPerTunnel" }, "task": true }, { "name": "restWlangwWlanGwBdUeRetrieveWlanGwUesPerBd", "summary": "retrieveWlanGwUesPerBd", "description": "Method retrieves all User Equipments of a given Bridge Identified on the specific Network Element. Intention : RETRIEVER retrieveWlanGwUesPerBd: class-level retriever API retrieveWlanGwUesPerBd of class wlangw.WlanGwBdUe", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInTimeout\": 123, \"aInBridgeId\": 123, \"aInMacAddr\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInTimeout": { "type": "integer" }, "aInBridgeId": { "type": "integer" }, "aInMacAddr": { "type": "string" } }, "description": "Model containing the method level model for WlanGwBdUe.retrieveWlanGwUesPerBd to decode json data to internal NFM-P object model" } } ], "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": "/restWlangwWlanGwBdUeRetrieveWlanGwUesPerBd" }, "task": true }, { "name": "restWlangwWlanGwBridgeDomainRetrieveWlanGwBd", "summary": "retrieveWlanGwBd", "description": "Method retrieves WLAN Gateway Bridge Domain. Intention : RETRIEVER retrieveWlanGwBd: class-level retriever API retrieveWlanGwBd of class wlangw.WlanGwBridgeDomain", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInTimeout\": 123, \"aInBridgeId\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInTimeout": { "type": "integer" }, "aInBridgeId": { "type": "integer" } }, "description": "Model containing the method level model for WlanGwBridgeDomain.retrieveWlanGwBd to decode json data to internal NFM-P object model" } } ], "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": "/restWlangwWlanGwBridgeDomainRetrieveWlanGwBd" }, "task": true }, { "name": "restWlangwWlanGwIsaGroupFindBaseCardsWithIsabb", "summary": "findBaseCardsWithIsabb", "description": "Intention : RETRIEVER findBaseCardsWithIsabb: instance-level [object finder] (retriever) API findBaseCardsWithIsabb of class wlangw.WlanGwIsaGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restWlangwWlanGwIsaGroupFindBaseCardsWithIsabb" }, "task": true }, { "name": "restWlangwWlanGwIsaGroupGetDependencyCount", "summary": "getDependencyCount", "description": "Intention : RETRIEVER getDependencyCount: instance-level retriever API getDependencyCount of class wlangw.WlanGwIsaGroup instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restWlangwWlanGwIsaGroupGetDependencyCount" }, "task": true }, { "name": "restWlangwWlanGwQbtTunnelRetrieveWlanGwTunnelCount", "summary": "retrieveWlanGwTunnelCount", "description": "Method to retrieve WLAN GW Tunnels count with specified parameters Intention : RETRIEVER retrieveWlanGwTunnelCount: class-level retriever API retrieveWlanGwTunnelCount of class wlangw.WlanGwQbtTunnel", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"tunnelServiceId\": 123, \"remoteAddr\": \"string\", \"localAddr\": \"string\", \"addrFamily\": \"string\", \"encap\": \"array\", \"vlanEncapTag1\": 123, \"vlanEncapTag2\": 123, \"apSapPortId\": 123, \"apSapEncap\": 123, \"numUeMin\": 123, \"numUeMax\": 123, \"apMacAddressFailed\": \"string\", \"ueType\": \"array\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "addrFamily", "apMacAddressFailed", "apSapEncap", "apSapPortId", "encap", "localAddr", "numUeMax", "numUeMin", "remoteAddr", "siteId", "timeout", "tunnelServiceId", "ueType", "vlanEncapTag1", "vlanEncapTag2" ], "properties": { "siteId": { "type": "string", "description": " Specifies the Network Element to query." }, "tunnelServiceId": { "type": "integer", "description": " Specifies the identifier of the service corresponding to thevirtual router instance where the tunneled traffic is routed.Valid values are -1 for the Base Routing Instance, or a validVPRN Service ID. default:0" }, "remoteAddr": { "type": "string", "description": " Specifies the IP address of the remote endpoint of the tunnel. default:" }, "localAddr": { "type": "string", "description": " Specifies the IP address of the local endpoint of the tunnel. default:" }, "addrFamily": { "type": "string", "description": " Specifies the address family of the IP layer of the tunnel.The only values allowed are 'ipv4' and 'ipv6'. default:0" }, "encap": { "type": "array", "description": " Specifies the encapsulation types present in the traffic received through a tunnel. default:0", "items": { "type": "string" } }, "vlanEncapTag1": { "type": "integer", "description": " Specifies the VLAN tag in case of IEEE 802.1Q encapsulation,or the outer tag (service tag, ethertype 0x88a8) in case of IEEE 802.1ad encapsulation,present in the traffic received through a tunnel. This parameteris only valid when the encap type is 'vlan'. If the encap value is not 'vlan',the value of vlanEncapTag1 must be the default minus one. default:-1" }, "vlanEncapTag2": { "type": "integer", "description": " Specifies the inner tag (customer tag, ethertype 0x8100) in case of qinq encapsulationpresent in the traffic received through a tunnel.This parameter is only valid when the encap type is 'vlan'. If the encap value is not 'vlan',the value of vlanEncapTag2 must be the default minus one. default:-1" }, "apSapPortId": { "type": "integer", "description": " Specifies the ID of the access port of the Access Point.If the encap value is not 'vlan', the value of apSapPortId must be the default 'invalid port ID'(503316480).Typically, the values of apSapPortId and apSapEncap are set together. default:503316480" }, "apSapEncap": { "type": "integer", "description": " Specifies the value of the label used to identify the SAP of the Access Point.If the encap value is not 'vlan', the value of apSapEncap must be the default zero.Typically, the values of apSapEncap and apSapPortId are set together. default:0" }, "numUeMin": { "type": "integer", "description": " Specifies the minimum number of UE's in the tunnel. default:0" }, "numUeMax": { "type": "integer", "description": " Specifies the maximum number of UE's in the tunnel. default:4294967295" }, "apMacAddressFailed": { "type": "string", "description": " Specifies if the learning of the MAC address of the Access Point failed. default:dontCare" }, "ueType": { "type": "array", "description": " Specifies the set of UE type values.When the value of ueType is not zero, the response will contain only objectswhere the number of UE's in one of the states corresponding to ueTypeis within the range of numUeMin and numUeMax. Typically, numUeMin will haveto be set to a non-default value of 1 or higher. default:0", "items": { "type": "string" } }, "timeout": { "type": "integer", "description": " Specifies the timeout in milliseconds to wait before receiving the results.If no results are received in the given time, the method returns.This is an optional input parameter. The default value is 5 minutes (300000ms). default:300000" } }, "description": "Model containing the method level model for WlanGwQbtTunnel.retrieveWlanGwTunnelCount to decode json data to internal NFM-P object model" } } ], "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": "/restWlangwWlanGwQbtTunnelRetrieveWlanGwTunnelCount" }, "task": true }, { "name": "restWlangwWlanGwQbtTunnelRetrieveWlanGwTunnels", "summary": "retrieveWlanGwTunnels", "description": "Method to retrieve WLAN GW Tunnels with specified parameters Intention : RETRIEVER retrieveWlanGwTunnels: class-level retriever API retrieveWlanGwTunnels of class wlangw.WlanGwQbtTunnel", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"tunnelServiceId\": 123, \"remoteAddr\": \"string\", \"localAddr\": \"string\", \"addrFamily\": \"string\", \"encap\": \"array\", \"vlanEncapTag1\": 123, \"vlanEncapTag2\": 123, \"apSapPortId\": 123, \"apSapEncap\": 123, \"numUeMin\": 123, \"numUeMax\": 123, \"apMacAddressFailed\": \"string\", \"ueType\": \"array\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "addrFamily", "apMacAddressFailed", "apSapEncap", "apSapPortId", "encap", "localAddr", "numUeMax", "numUeMin", "remoteAddr", "siteId", "timeout", "tunnelServiceId", "ueType", "vlanEncapTag1", "vlanEncapTag2" ], "properties": { "siteId": { "type": "string", "description": " Specifies the Network Element to query." }, "tunnelServiceId": { "type": "integer", "description": " Specifies the identifier of the service corresponding to thevirtual router instance where the tunneled traffic is routed.Valid values are -1 to indicate Base Routing Instance, or a validVPRN Service ID. default:0" }, "remoteAddr": { "type": "string", "description": " Specifies the IP address of the remote endpoint of the tunnel. default:" }, "localAddr": { "type": "string", "description": " Specifies the IP address of the local endpoint of the tunnel. default:" }, "addrFamily": { "type": "string", "description": " Specifies the address family of the IP layer of the tunnel.The only values allowed are 'ipv4' and 'ipv6'. default:0" }, "encap": { "type": "array", "description": " Specifies the encapsulation types present in the traffic received through a tunnel. default:0", "items": { "type": "string" } }, "vlanEncapTag1": { "type": "integer", "description": " Specifies the VLAN tag in case of IEEE 802.1Q encapsulation,or the outer tag (service tag, ethertype 0x88a8) in case of IEEE 802.1ad encapsulation,present in the traffic received through a tunnel. This parameteris only valid when the encap type is 'vlan'. If the encap value is not 'vlan',the value of vlanEncapTag1 must be the default minus one. default:-1" }, "vlanEncapTag2": { "type": "integer", "description": " Specifies the inner tag (customer tag, ethertype 0x8100) in case of qinq encapsulationpresent in the traffic received through a tunnel.This parameter is only valid when the encap type is 'vlan'. If the encap value is not 'vlan',the value of vlanEncapTag2 must be the default minus one. default:-1" }, "apSapPortId": { "type": "integer", "description": " Specifies the ID of the access port of the Access Point.If the encap value is not 'vlan', the value of apSapPortId must be the default 'invalid port ID'(503316480). default:503316480" }, "apSapEncap": { "type": "integer", "description": " Specifies the value of the label used to identify the SAP of the Access Point.If the encap value is not 'vlan', the value of apSapEncap must be the default zero. default:0" }, "numUeMin": { "type": "integer", "description": " Specifies the minimum number of UE's in the tunnel. default:0" }, "numUeMax": { "type": "integer", "description": " Specifies the maximum number of UE's in the tunnel. default:4294967295" }, "apMacAddressFailed": { "type": "string", "description": " Specifies if the learning of the MAC address of the Access Point failed. default:dontCare" }, "ueType": { "type": "array", "description": " Specifies the set of UE type values.When the value of ueType is not zero, the response will contain only objectswhere the number of UE's in one of the states corresponding to ueTypeis within the range of numUeMin and numUeMax. Typically, numUeMin will haveto be set to a non-default value of 1 or higher. default:0", "items": { "type": "string" } }, "timeout": { "type": "integer", "description": " Specifies the timeout in milliseconds to wait before receiving the results.If no results are received in the given time, the method returns.This is an optional input parameter. The default value is 5 minutes (300000ms). default:300000" } }, "description": "Model containing the method level model for WlanGwQbtTunnel.retrieveWlanGwTunnels to decode json data to internal NFM-P object model" } } ], "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": "/restWlangwWlanGwQbtTunnelRetrieveWlanGwTunnels" }, "task": true }, { "name": "restWlangwWlanGwQbtTunnelValidateQuery", "summary": "validateQuery", "description": "Intention : RETRIEVER validateQuery: class-level retriever API validateQuery of class wlangw.WlanGwQbtTunnel", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"tunnelServiceId\": 123}", "required": false, "schema": { "type": "object", "required": [ "siteId", "tunnelServiceId" ], "properties": { "siteId": { "type": "string", "description": " Site ID to be validated against sites managed by NFM-P." }, "tunnelServiceId": { "type": "integer", "description": " Optional parameter. Service ID to be validated against services in NFM-P.Valid values are -1 for the Base Routing Instance, or a validVPRN Service ID. default:0" } }, "description": "Model containing the method level model for WlanGwQbtTunnel.validateQuery to decode json data to internal NFM-P object model" } } ], "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": "/restWlangwWlanGwQbtTunnelValidateQuery" }, "task": true }, { "name": "restWlangwWlanGwQbtUeRetrieveWlanGwUeCount", "summary": "retrieveWlanGwUeCount", "description": "Method to retrieve WLAN GW User Equipment count with specified parameters Intention : RETRIEVER retrieveWlanGwUeCount: class-level retriever API retrieveWlanGwUeCount of class wlangw.WlanGwQbtUe", "input": [ { "name": "body", "type": "object", "info": ": {\"aInBridgeId\": 123, \"aUeQueryStruct\": {\"objectClassName\": \"string\", \"ueEncapsulation\": \"string\", \"ueState\": \"array\", \"siteId\": \"string\", \"macAddr\": \"string\", \"ueAddress\": \"string\", \"dhcpV6Addr\": \"string\", \"slaacPrefix\": \"string\", \"tunnelRouterId\": 123, \"serviceId\": 123, \"tunnelSrcAddr\": \"string\", \"tunnelDstAddr\": \"string\", \"isaGroupId\": 123, \"isaMemberId\": 123}, \"aInVlanQTag\": 123, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInBridgeId": { "type": "integer" }, "aUeQueryStruct": { "type": "object", "required": [ "dhcpV6Addr", "isaGroupId", "isaMemberId", "macAddr", "objectClassName", "serviceId", "siteId", "slaacPrefix", "tunnelDstAddr", "tunnelRouterId", "tunnelSrcAddr", "ueAddress", "ueEncapsulation", "ueState" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "ueEncapsulation": { "type": "string" }, "ueState": { "type": "array", "items": { "type": "string" } }, "siteId": { "type": "string" }, "macAddr": { "type": "string" }, "ueAddress": { "type": "string" }, "dhcpV6Addr": { "type": "string" }, "slaacPrefix": { "type": "string" }, "tunnelRouterId": { "type": "integer" }, "serviceId": { "type": "integer" }, "tunnelSrcAddr": { "type": "string" }, "tunnelDstAddr": { "type": "string" }, "isaGroupId": { "type": "integer" }, "isaMemberId": { "type": "integer" } }, "description": "Model containing the method level model for struct WlanGwQbtUeQueryStruct. to decode json data to internal NFM-P object model" }, "aInVlanQTag": { "type": "integer" }, "timeout": { "type": "integer", "description": " Specifies the timeout in milliseconds to wait before receiving the results. If no results are received in the given time, the method returns. This is an optional input parameter. The default value is 5 minutes (300000ms). default:0" } }, "description": "Model containing the method level model for WlanGwQbtUe.retrieveWlanGwUeCount to decode json data to internal NFM-P object model" } } ], "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": "/restWlangwWlanGwQbtUeRetrieveWlanGwUeCount" }, "task": true }, { "name": "restWlangwWlanGwQbtUeRetrieveWlanGwUes", "summary": "retrieveWlanGwUes", "description": "Method to retrieve WLAN GW User Equipments with specified parameters Intention : RETRIEVER retrieveWlanGwUes: class-level retriever API retrieveWlanGwUes of class wlangw.WlanGwQbtUe", "input": [ { "name": "body", "type": "object", "info": ": {\"aInBridgeId\": 123, \"aUeQueryStruct\": {\"objectClassName\": \"string\", \"ueEncapsulation\": \"string\", \"ueState\": \"array\", \"siteId\": \"string\", \"macAddr\": \"string\", \"ueAddress\": \"string\", \"dhcpV6Addr\": \"string\", \"slaacPrefix\": \"string\", \"tunnelRouterId\": 123, \"serviceId\": 123, \"tunnelSrcAddr\": \"string\", \"tunnelDstAddr\": \"string\", \"isaGroupId\": 123, \"isaMemberId\": 123}, \"aInVlanQTag\": 123, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInBridgeId": { "type": "integer" }, "aUeQueryStruct": { "type": "object", "required": [ "dhcpV6Addr", "isaGroupId", "isaMemberId", "macAddr", "objectClassName", "serviceId", "siteId", "slaacPrefix", "tunnelDstAddr", "tunnelRouterId", "tunnelSrcAddr", "ueAddress", "ueEncapsulation", "ueState" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "ueEncapsulation": { "type": "string" }, "ueState": { "type": "array", "items": { "type": "string" } }, "siteId": { "type": "string" }, "macAddr": { "type": "string" }, "ueAddress": { "type": "string" }, "dhcpV6Addr": { "type": "string" }, "slaacPrefix": { "type": "string" }, "tunnelRouterId": { "type": "integer" }, "serviceId": { "type": "integer" }, "tunnelSrcAddr": { "type": "string" }, "tunnelDstAddr": { "type": "string" }, "isaGroupId": { "type": "integer" }, "isaMemberId": { "type": "integer" } }, "description": "Model containing the method level model for struct WlanGwQbtUeQueryStruct. to decode json data to internal NFM-P object model" }, "aInVlanQTag": { "type": "integer" }, "timeout": { "type": "integer", "description": " Specifies the timeout in milliseconds to wait before receiving the results.If no results are received in the given time, the method returns.This is an optional input parameter. The default value is 5 minutes (300000ms). default:0" } }, "description": "Model containing the method level model for WlanGwQbtUe.retrieveWlanGwUes to decode json data to internal NFM-P object model" } } ], "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": "/restWlangwWlanGwQbtUeRetrieveWlanGwUes" }, "task": true }, { "name": "restWlangwWlanGwQbtUeValidateQuery", "summary": "validateQuery", "description": "Intention : RETRIEVER validateQuery: class-level retriever API validateQuery of class wlangw.WlanGwQbtUe", "input": [ { "name": "body", "type": "object", "info": ": {\"siteId\": \"string\", \"tunnelServiceId\": 123}", "required": false, "schema": { "type": "object", "required": [ "siteId", "tunnelServiceId" ], "properties": { "siteId": { "type": "string", "description": " Site ID to be validated against sites managed by NFM-P." }, "tunnelServiceId": { "type": "integer", "description": " Optional parameter. Service ID to be validated against services in NFM-P.Valid values are -1 for the Base Routing Instance, or a validVPRN Service ID. default:0" } }, "description": "Model containing the method level model for WlanGwQbtTunnel.validateQuery to decode json data to internal NFM-P object model" } } ], "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": "/restWlangwWlanGwQbtUeValidateQuery" }, "task": true }, { "name": "restWlangwWlanGwRedundancyConfigForceSwitchover", "summary": "rest_wlangw_WlanGwRedundancyConfig_forceSwitchover", "description": "rest_wlangw_WlanGwRedundancyConfig_forceSwitchover", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInInterfaceId\": 123, \"aInServiceId\": 123}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInInterfaceId": { "type": "integer" }, "aInServiceId": { "type": "integer" } }, "description": "Model containing the method level model for WlanGwRedundancyConfig.forceSwitchover to decode json data to internal NFM-P object model" } } ], "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": "/restWlangwWlanGwRedundancyConfigForceSwitchover" }, "task": true }, { "name": "restWlangwWlanGwTuQosRetrieveQos", "summary": "retrieveQos", "description": "Method used to retrieve WLAN GW Tunnel QoS from NE. Intention : RETRIEVER retrieveQos: class-level retriever API retrieveQos of class wlangw.WlanGwTuQos", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"routerId\": 123, \"remoteAddress\": \"string\", \"localAddress\": \"string\", \"retailServiceId\": 123, \"getTunnel\": \"boolean\", \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "getTunnel", "localAddress", "objectClassName", "remoteAddress", "retailServiceId", "routerId", "siteId", "timeout" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "routerId": { "type": "integer" }, "remoteAddress": { "type": "string" }, "localAddress": { "type": "string" }, "retailServiceId": { "type": "integer" }, "getTunnel": { "type": "boolean", "default": false }, "timeout": { "type": "integer" } }, "description": "Model containing the method level model for struct QoSRetrievalStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restWlangwWlanGwTuQosRetrieveQos" }, "task": true }, { "name": "restWlangwWlanGwUeRetrieveWlanGwUes", "summary": "retrieveWlanGwUes", "description": "Method queries the NE for the User Equipments resides on the specified tunnel (Base or VPRN). Intention : RETRIEVER retrieveWlanGwUes: class-level retriever API retrieveWlanGwUes of class wlangw.WlanGwUe", "input": [ { "name": "body", "type": "object", "info": ": {\"aInBridgeId\": 123, \"aUeQueryStruct\": {\"objectClassName\": \"string\", \"ueEncapsulation\": \"string\", \"ueState\": \"array\", \"siteId\": \"string\", \"macAddr\": \"string\", \"ueAddress\": \"string\", \"dhcpV6Addr\": \"string\", \"slaacPrefix\": \"string\", \"tunnelRouterId\": 123, \"serviceId\": 123, \"tunnelSrcAddr\": \"string\", \"tunnelDstAddr\": \"string\", \"isaGroupId\": 123, \"isaMemberId\": 123}, \"aInVlanQTag\": 123, \"timeout\": 123}", "required": false, "schema": { "type": "object", "required": [ "timeout" ], "properties": { "aInBridgeId": { "type": "integer" }, "aUeQueryStruct": { "type": "object", "required": [ "dhcpV6Addr", "isaGroupId", "isaMemberId", "macAddr", "objectClassName", "serviceId", "siteId", "slaacPrefix", "tunnelDstAddr", "tunnelRouterId", "tunnelSrcAddr", "ueAddress", "ueEncapsulation", "ueState" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "ueEncapsulation": { "type": "string" }, "ueState": { "type": "array", "items": { "type": "string" } }, "siteId": { "type": "string" }, "macAddr": { "type": "string" }, "ueAddress": { "type": "string" }, "dhcpV6Addr": { "type": "string" }, "slaacPrefix": { "type": "string" }, "tunnelRouterId": { "type": "integer" }, "serviceId": { "type": "integer" }, "tunnelSrcAddr": { "type": "string" }, "tunnelDstAddr": { "type": "string" }, "isaGroupId": { "type": "integer" }, "isaMemberId": { "type": "integer" } }, "description": "Model containing the method level model for struct WlanGwQbtUeQueryStruct. to decode json data to internal NFM-P object model" }, "aInVlanQTag": { "type": "integer" }, "timeout": { "type": "integer", "description": " Specifies the timeout in milliseconds to wait before receiving the results.If no results are received in the given time, the method returns.This is an optional input parameter. The default value is 5 minutes (300000ms). default:0" } }, "description": "Model containing the method level model for WlanGwQbtUe.retrieveWlanGwUes to decode json data to internal NFM-P object model" } } ], "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": "/restWlangwWlanGwUeRetrieveWlanGwUes" }, "task": true }, { "name": "restWlangwWlanGwUeRetrieveWlanGwUesByMacAddr", "summary": "retrieveWlanGwUesByMacAddr", "description": "Method queries the specific NE for the User Equipments by given MAC Address. Intention : RETRIEVER retrieveWlanGwUesByMacAddr: class-level retriever API retrieveWlanGwUesByMacAddr of class wlangw.WlanGwUe", "input": [ { "name": "body", "type": "object", "info": ": {\"aInSiteId\": \"string\", \"aInMacAddr\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInMacAddr": { "type": "string" } }, "description": "Model containing the method level model for WlanGwUe.retrieveWlanGwUesByMacAddr to decode json data to internal NFM-P object model" } } ], "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": "/restWlangwWlanGwUeRetrieveWlanGwUesByMacAddr" }, "task": true }, { "name": "restWppPortalRetrieveHost", "summary": "retrieveHost", "description": "Intention : RETRIEVER retrieveHost: instance-level retriever API retrieveHost of class wpp.Portal instanceFullName : distinguished/instance name of called object", "input": [ { "name": "instanceFullName", "type": "string", "info": ": string", "required": true, "schema": { "title": "instanceFullName", "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": "/restWppPortalRetrieveHost" }, "task": true }, { "name": "restWppWppHostRequestClearWppHostsLoggingOut", "summary": "requestClearWppHostsLoggingOut", "description": "Request clearing the logging out WPP host(s) with the specified parameters. The siteId is required. The svcId should be 0 for base routing instance or the ID of the VPRN service. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager. Intention : MODIFIER requestClearWppHostsLoggingOut: cl...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"objectClassName\": \"string\", \"siteId\": \"string\", \"svcId\": 123, \"portalName\": \"string\", \"hostAddress\": \"string\"}", "required": false, "schema": { "type": "object", "required": [ "hostAddress", "objectClassName", "portalName", "siteId", "svcId" ], "properties": { "objectClassName": { "type": "string", "example": "String", "description": "packageName.className of the child object " }, "siteId": { "type": "string" }, "svcId": { "type": "integer" }, "portalName": { "type": "string" }, "hostAddress": { "type": "string" } }, "description": "Model containing the method level model for struct ClearWppHostsLoggingOutStruct. to decode json data to internal NFM-P object model" } } ], "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": "/restWppWppHostRequestClearWppHostsLoggingOut" }, "task": true }, { "name": "xmltojsonEndpoint", "summary": "NFMP REST-API v3 convert XML to JSON command", "description": "Use this endpoint to convert any XML or SOAP XML message, and it will return the proper JSON body that you can use for the v3 api.For example, the client makes the following HTTP request:\n \n\n POST /v3/xml-to-json HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/xml\n\n aclfilter.IpFilter \n \n\n\n Which returns: \n\n {\"find\": {\"fullClassName\": \"aclfilter.IpFilter\"}}", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/xmltojsonEndpoint" }, "task": true }, { "name": "xmlEndpoint", "summary": "NFMP REST-API v3 'xml' command", "description": "This is the XML REST_API endpoint. Use this endpoint to send XML directly instead of JSON. For example, the client makes the following HTTP request:\n \n\n POST /v3/xml HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/xml\n\n aclfilter.IpFilter", "input": [ { "name": "body", "type": "string", "info": ": string", "required": false, "schema": { "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": "/xmlEndpoint" }, "task": true }, { "name": "requestEndpoint", "summary": "NFMP REST-API v3 'request' command", "description": "This is the NFMP REST_API endpoint. Use this endpoint to send your converted JSON and obtain a JSON response. For example, the client makes the following HTTP request:\n \n\n POST /v3/request HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n Example that returns JSON response:\n {\"fullClassName\":[\"netw.NetworkElement\"], \"fileName\": \"myFile.xml\", \"resultFilter\": { \"attributes\": [\"objectF...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object", "additionalProperties": { "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": "/requestEndpoint" }, "task": true }, { "name": "findEndpoint", "summary": "NFMP REST-API v3 'find' command", "description": "This is the recommended endpoint for performing a REST- API v3 \"find\" requests and it is mandatory for any finds with a large result set. The response is only in XML format. For example, the client makes the following HTTP request:\n \n \n POST /v3/find HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n {\"find\": {\n \"fullClassName\": \"security.User\",\n \"resultFilter\": {\n \"chil...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": object", "required": false, "schema": { "type": "object", "additionalProperties": { "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": "/findEndpoint" }, "task": true } ], "views": [] }