@itentialopensource/adapter-nokia_nsp_nfm_p
Version:
This adapter integrates with system described as: nfm-p(SAMO).
1,563 lines (1,562 loc) • 3.24 MB
JSON
{
"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",