{ "id": "@itentialopensource/adapter-nokia_nsp_network", "type": "Adapter", "export": "NokiaNspNetwork", "title": "Nokia_nsp_network", "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": "getCardSlotsUsingGET", "summary": "getCardSlotsUsingGET", "description": "Returns a paged list of specific card slots. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting card slot. Each card slot contains a link to the installed card, if not empty. Not providing a filter will return all card slots. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The user friend...(description truncated)", "input": [ { "name": "fdns", "type": "string", "info": "A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.: string", "required": false, "schema": { "title": "fdns", "type": "string" } }, { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "limit", "type": "number", "info": "The limit on the number of objects returned (max: 1000): 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "Start row for paged data (max: total number of objects): 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "CardSlot", "type": "object", "properties": { "links": { "xml": { "namespace": "http://www.w3.org/2005/Atom", "attribute": false, "wrapped": false }, "type": "array", "items": { "title": "Link", "type": "object", "properties": { "href": { "xml": { "name": "href", "attribute": true, "wrapped": false }, "type": "string" }, "rel": { "xml": { "name": "rel", "attribute": true, "wrapped": false }, "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "description": "The Fully Distinguished Name of this Card Slot.", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType2", "description": "The type of the source system where this Card Slot is sourced from.", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "description": "The type of the source system where this Card Slot is sourced from." } ] }, "sourceSystem": { "description": "The source system where this Card Slot is sourced from.", "type": "string" }, "sources": { "description": "The Fully Distinguished Names of the Card Slots from the source system associated to this Card Slot.", "type": "array", "items": { "type": "string" } }, "name": { "description": "The name of this Card Slot, as defined by the source system.", "type": "string" }, "neName": { "description": "The name of the Network Element containing this Card Slot, as defined by the source system.", "type": "string" }, "neId": { "description": "The id of the Network Element containing this Card Slot, as defined by the source system.", "type": "string" }, "description": { "description": "The detailed description of this Card Slot.", "type": "string" }, "positionId": { "description": "The relative position of the Card Slot, that determines the order in which to show it in the source system UI.", "type": "integer" }, "position": { "description": "A formatted name that describes the position of the Card Slot within the Network Element.", "type": "string" }, "adminState": { "type": "object", "allOf": [ { "title": "AdminState1", "description": "The administrative state of this Card Slot. Refer to the X.731 standard.", "example": "unlocked", "type": "string", "enum": [ "unknown", "unlocked", "locked", "forcedLockout", "shuttingDown", "maintenance" ] }, { "description": "The administrative state of this Card Slot. Refer to the X.731 standard." } ] }, "operState": { "type": "object", "allOf": [ { "title": "OperState1", "description": "The operational state of this Card Slot. Refer to the X.731 standard.", "example": "enabled", "type": "string", "enum": [ "unknown", "enabled", "disabled" ] }, { "description": "The operational state of this Card Slot. Refer to the X.731 standard." } ] }, "standbyState": { "type": "object", "allOf": [ { "title": "StandbyState1", "description": "The standby state of this Card Slot. Refer to the X.731 standard.", "example": "providingService", "type": "string", "enum": [ "providingService", "standby" ] }, { "description": "The standby state of this Card Slot. Refer to the X.731 standard." } ] }, "availabilityStates": { "description": "The availability states of this Card Slot. Refer to the X.731 standard.", "type": "array", "items": { "title": "AvailabilityState", "type": "string", "enum": [ "unknown", "inTest", "failed", "degraded", "offLine", "powerOff", "offDuty", "dependency", "notInstalled", "logFull" ] } }, "stateReasons": { "description": "A set of specific reasons why the Card Slot is in this state.", "type": "array", "items": { "type": "string" } }, "objectDetails": { "description": "Generic properties of this Card Slot, specific to the Network Supervision application.", "type": "object", "additionalProperties": { "type": "string" } }, "manufacturer": { "description": "The vendor of the Card Slot.", "type": "string" }, "serialNumber": { "description": "The serial number of the Card Slot provided by the manufacturer.", "type": "string" }, "partNumber": { "description": "The part number of the Card Slot provided by the manufacturer.", "type": "string" }, "manufacturerAssemblyNumber": { "description": "The assembly number of the Card Slot provided by the manufacturer.", "type": "string" }, "manufactureDate": { "description": "The date of manufacture of the Card Slot.", "type": "string" }, "manufacturingDeviations": { "description": "The manufacturing deviations of the Card Slot provided by the manufacturer.", "type": "string" }, "macAddress": { "description": "The Base MAC Address of the Card Slot", "type": "string" }, "hwMacAddress": { "description": "The Hardware MAC Address of the Card Slot", "type": "string" }, "provisionedType": { "description": "The type of Card provisioned in this Card Slot.", "type": "string" }, "actualType": { "description": "The type of Card present in this Card Slot.", "type": "string" }, "holderState": { "description": "The status of the Card Slot.", "type": "string" } }, "required": [ "fdn", "sourceType", "sourceSystem", "sources", "name", "neName", "neId", "positionId", "position", "adminState", "operState", "standbyState", "availabilityStates", "provisionedType", "actualType", "holderState" ] } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCardSlotsUsingGET" }, "task": true }, { "name": "getCardSlotUsingGET", "summary": "getCardSlotUsingGET", "description": "Returns detailed information for the specified card slot, which contains a link to the installed card, if not empty. Example: GET /v1/cardSlots/fdn:model:equipment:EquipmentHolder:2127", "input": [ { "name": "cardSlotFdn", "type": "string", "info": "cardSlotFdn: string", "required": true, "schema": { "title": "cardSlotFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCardSlotUsingGET" }, "task": true }, { "name": "getCardsUsingGET", "summary": "getCardsUsingGET", "description": "Returns a paged list of specific cards. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting card. Not providing a filter will return all cards. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The user friendly visible name neName: The name of the Network Element containing the Card ne...(description truncated)", "input": [ { "name": "fdns", "type": "string", "info": "A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.: string", "required": false, "schema": { "title": "fdns", "type": "string" } }, { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "limit", "type": "number", "info": "The limit on the number of objects returned (max: 1000): 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "Start row for paged data (max: total number of objects): 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "Card", "type": "object", "properties": { "links": { "xml": { "namespace": "http://www.w3.org/2005/Atom", "attribute": false, "wrapped": false }, "type": "array", "items": { "title": "Link", "type": "object", "properties": { "href": { "xml": { "name": "href", "attribute": true, "wrapped": false }, "type": "string" }, "rel": { "xml": { "name": "rel", "attribute": true, "wrapped": false }, "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "description": "The Fully Distinguished Name of this Card.", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType", "description": "The type of the source system where this Card is sourced from.", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "description": "The type of the source system where this Card is sourced from." } ] }, "sourceSystem": { "description": "The source system where this Card is sourced from.", "type": "string" }, "sources": { "description": "The Fully Distinguished Names of the Cards from the source system associated to this Card.", "type": "array", "items": { "type": "string" } }, "name": { "description": "The name of this Card, as defined by the source system.", "type": "string" }, "neName": { "description": "The name of the Network Element containing this Card, as defined by the source system.", "type": "string" }, "neId": { "description": "The id of the Network Element containing this Card, as defined by the source system.", "type": "string" }, "description": { "description": "The detailed description of this Card.", "type": "string" }, "positionId": { "description": "The relative position of the Card, that determines the order in which to show it in the source system UI.", "type": "integer" }, "position": { "description": "A formatted name that describes the position of the Card within the Network Element.", "type": "string" }, "adminState": { "type": "object", "allOf": [ { "title": "AdminState", "description": "The administrative state of this Card. Refer to the X.731 standard.", "example": "unlocked", "type": "string", "enum": [ "unknown", "unlocked", "locked", "forcedLockout", "shuttingDown", "maintenance" ] }, { "description": "The administrative state of this Card. Refer to the X.731 standard." } ] }, "operState": { "type": "object", "allOf": [ { "title": "OperState", "description": "The operational state of this Card. Refer to the X.731 standard.", "example": "enabled", "type": "string", "enum": [ "unknown", "enabled", "disabled" ] }, { "description": "The operational state of this Card. Refer to the X.731 standard." } ] }, "standbyState": { "type": "object", "allOf": [ { "title": "StandbyState", "description": "The standby state of this Card. Refer to the X.731 standard.", "example": "providingService", "type": "string", "enum": [ "providingService", "standby" ] }, { "description": "The standby state of this Card. Refer to the X.731 standard." } ] }, "availabilityStates": { "description": "The availability states of this Card. Refer to the X.731 standard.", "type": "array", "items": { "title": "AvailabilityState", "type": "string", "enum": [ "unknown", "inTest", "failed", "degraded", "offLine", "powerOff", "offDuty", "dependency", "notInstalled", "logFull" ] } }, "stateReasons": { "description": "A set of specific reasons why the Card is in this state.", "type": "array", "items": { "type": "string" } }, "objectDetails": { "description": "Generic properties of this Card, specific to the Network Supervision application.", "type": "object", "additionalProperties": { "type": "string" } }, "manufacturer": { "description": "The vendor of the Card.", "type": "string" }, "serialNumber": { "description": "The serial number of the Card provided by the manufacturer.", "type": "string" }, "partNumber": { "description": "The part number of the Card provided by the manufacturer.", "type": "string" }, "manufacturerAssemblyNumber": { "description": "The assembly number of the Card provided by the manufacturer.", "type": "string" }, "manufactureDate": { "description": "The date of manufacture of the Card.", "type": "string" }, "manufacturingDeviations": { "description": "The manufacturing deviations of the Card provided by the manufacturer.", "type": "string" }, "macAddress": { "description": "The Base MAC Address of the Card", "type": "string" }, "hwMacAddress": { "description": "The Hardware MAC Address of the Card", "type": "string" }, "cardDetails": { "title": "CardDetails", "type": "object", "properties": { "fdn": { "example": "fdn:model:equipment:CardDetails:2203", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType1", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "example": "nfmp" } ] }, "sourceSystem": { "example": "fdn:realm:sam", "type": "string" }, "sources": { "example": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card@cardDetails" ], "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "cardType": { "description": "The type of this Card.", "example": "500g CPM / Switch Fabric 3", "type": "string" }, "equippedPorts": { "description": "The number of ports equipped directly on this Card.", "example": 40, "type": "integer" }, "capabilities": { "description": "A set of specific capabilities of the Card.", "type": "array", "items": { "type": "string" } }, "availableSlots": { "description": "The number of available card slots on this Card.", "example": 2, "type": "integer" }, "installedSlots": { "description": "The number of installed slots on this Card.", "example": 1, "type": "integer" }, "memorySize": { "description": "The Memory Size of this Card in MB.", "example": 16392, "type": "integer" }, "lastBootUpReason": { "description": "The last boot-up reason of this Card.", "example": "Hard Reboot", "type": "string" } } } }, "required": [ "fdn", "sourceType", "sourceSystem", "sources", "name", "neName", "neId", "positionId", "position", "adminState", "operState", "standbyState", "availabilityStates" ] } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCardsUsingGET" }, "task": true }, { "name": "getCardUsingGET", "summary": "getCardUsingGET", "description": "Returns detailed information for the specified card. Example: GET /v1/cards/fdn:model:equipment:Equipment:2184", "input": [ { "name": "cardFdn", "type": "string", "info": "cardFdn: string", "required": true, "schema": { "title": "cardFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCardUsingGET" }, "task": true }, { "name": "getLAGsUsingGET", "summary": "getLAGsUsingGET", "description": "Returns a paged list of specific LAGs. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting LAG. Not providing a filter will return all LAGs. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The user friendly visible name neName: The name of this LAG neId: The id of this LAG descripti...(description truncated)", "input": [ { "name": "fdns", "type": "string", "info": "A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.: string", "required": false, "schema": { "title": "fdns", "type": "string" } }, { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "limit", "type": "number", "info": "The limit on the number of objects returned (max: 1000): 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "Start row for paged data (max: total number of objects): 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "LAG", "type": "object", "properties": { "links": { "xml": { "namespace": "http://www.w3.org/2005/Atom", "attribute": false, "wrapped": false }, "type": "array", "items": { "title": "Link", "type": "object", "properties": { "href": { "xml": { "name": "href", "attribute": true, "wrapped": false }, "type": "string" }, "rel": { "xml": { "name": "rel", "attribute": true, "wrapped": false }, "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "description": "The Fully Distinguished Name of this LAG.", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType3", "description": "The type of the source system where this LAG is sourced from.", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "description": "The type of the source system where this LAG is sourced from." } ] }, "sourceSystem": { "description": "The source system where this LAG is sourced from.", "type": "string" }, "sources": { "description": "The Fully Distinguished Names of the LAGs from the source system associated to this LAG.", "type": "array", "items": { "type": "string" } }, "lagId": { "description": "The short identifier of this LAG, as defined by the source system", "type": "string" }, "neName": { "description": "The name of this LAG. Is unique within the source system.", "type": "string" }, "neId": { "description": "The id of this LAG. Is unique within the source system.", "type": "string" }, "name": { "description": "The name of this LAG, as defined by the source system.", "type": "string" }, "description": { "description": "The detailed description of this LAG.", "type": "string" }, "configuredAddress": { "description": "The MAC Address of this LAG.", "type": "string" }, "encapType": { "type": "object", "allOf": [ { "title": "EncapType", "description": "The encapsulation type of this LAG.", "example": "nullEncap", "type": "string", "enum": [ "unknown", "other", "nullEncap", "dot1q", "qinq", "mpls", "bcpNull", "bcpDot1q", "ipcp", "frameRelay", "pppAuto", "atm", "wanMirror", "ciscoHdlc", "cem", "rhdlc", "raw", "cellular", "wlan" ] }, { "description": "The encapsulation type of this LAG." } ] }, "operationalSpeedUnits": { "description": "The units associated to the 'operationalSpeed' field value for this LAG.", "type": "string" }, "operationalSpeed": { "description": "The total operational speed of this LAG, in units specified by the 'operationalSpeedUnits' field value.", "type": "number" }, "lagMode": { "type": "object", "allOf": [ { "title": "LagMode", "description": "The mode of this LAG.", "example": "access", "type": "string", "enum": [ "undefined", "access", "trunk", "hybrid" ] }, { "description": "The mode of this LAG." } ] }, "adminState": { "type": "object", "allOf": [ { "title": "AdminState2", "description": "The administrative state of this LAG. Refer to the X.731 standard.", "example": "unlocked", "type": "string", "enum": [ "unknown", "unlocked", "locked", "forcedLockout", "shuttingDown", "maintenance" ] }, { "description": "The administrative state of this LAG. Refer to the X.731 standard." } ] }, "operState": { "type": "object", "allOf": [ { "title": "OperState2", "description": "The operational state of this LAG. Refer to the X.731 standard.", "example": "enabled", "type": "string", "enum": [ "unknown", "enabled", "disabled" ] }, { "description": "The operational state of this LAG. Refer to the X.731 standard." } ] }, "standbyState": { "type": "object", "allOf": [ { "title": "StandbyState2", "description": "The standby state of this LAG. Refer to the X.731 standard", "example": "providingService", "type": "string", "enum": [ "providingService", "standby" ] }, { "description": "The standby state of this LAG. Refer to the X.731 standard" } ] }, "availabilityStates": { "description": "The availability states of this LAG. Refer to the X.731 standard.", "type": "array", "items": { "title": "AvailabilityState", "type": "string", "enum": [ "unknown", "inTest", "failed", "degraded", "offLine", "powerOff", "offDuty", "dependency", "notInstalled", "logFull" ] } }, "stateReasons": { "description": "A set of specific reasons why the LAG is in this state.", "type": "array", "items": { "type": "string" } }, "objectDetails": { "description": "Generic properties of this LAG, specific to the Network Supervision application", "type": "object", "additionalProperties": { "type": "string" } }, "members": { "type": "array", "items": { "title": "LAGMemberDetails", "type": "object", "properties": { "encapType": { "type": "string" }, "fdn": { "type": "string" }, "lagId": { "type": "string" }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "portFdn": { "type": "string" }, "portName": { "type": "string" }, "priority": { "type": "integer" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" } } } }, "multiChassisLAGMembers": { "type": "array", "items": { "title": "MultiChassisLAGMember", "type": "object", "properties": { "description": { "type": "string" }, "fdn": { "type": "string" }, "lacpKey": { "type": "integer" }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "peerIpAddress": { "type": "string" }, "peerNeId": { "type": "string" }, "remoteLagId": { "type": "string" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" }, "systemId": { "type": "string" }, "systemPriority": { "type": "integer" } } } }, "parentNe": { "description": "The Fully Distinguished Name of the Network Element containing this LAG.", "type": "string" }, "parent": { "description": "The Fully Distinguished Name of the Radio Equipment containing this LAG.", "type": "string" } }, "required": [ "fdn", "sourceType", "sourceSystem", "sources", "lagId", "neName", "neId", "name", "encapType", "adminState", "operState", "standbyState", "parentNe" ] } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getLAGsUsingGET" }, "task": true }, { "name": "getLAGUsingGET", "summary": "getLAGUsingGET", "description": "Returns detailed information for the specified LAG. Example: GET /v1/lags/fdn:model:equipment:LAG:12872", "input": [ { "name": "lagFdn", "type": "string", "info": "lagFdn: string", "required": true, "schema": { "title": "lagFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getLAGUsingGET" }, "task": true }, { "name": "getNEsUsingGET", "summary": "getNEsUsingGET", "description": "Returns a paged list of specific network elements. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting network element. Not providing a filter will return all network elements. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The name of this Network Element, as defined by the source system...(description truncated)", "input": [ { "name": "fdns", "type": "string", "info": "A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.: string", "required": false, "schema": { "title": "fdns", "type": "string" } }, { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "limit", "type": "number", "info": "The limit on the number of objects returned (max: 1000): 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "Start row for paged data (max: total number of objects): 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "NetworkElement", "type": "object", "properties": { "links": { "xml": { "namespace": "http://www.w3.org/2005/Atom", "attribute": false, "wrapped": false }, "type": "array", "items": { "title": "Link", "type": "object", "properties": { "href": { "xml": { "name": "href", "attribute": true, "wrapped": false }, "type": "string" }, "rel": { "xml": { "name": "rel", "attribute": true, "wrapped": false }, "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "description": "The Fully Distinguished Name of this Network Element.", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType4", "description": "The type of the source system where this Network Element is sourced from.", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "description": "The type of the source system where this Network Element is sourced from." } ] }, "sourceSystem": { "description": "The source system where this Network Element is sourced from.", "type": "string" }, "sources": { "description": "The Fully Distinguished Names of the Network Elements from the source system associated to this Network Element.", "type": "array", "items": { "type": "string" } }, "name": { "description": "The name of this Network Element, as defined by the source system.", "type": "string" }, "neName": { "description": "The name of this Network Element. Is unique within the source system.", "type": "string" }, "neId": { "description": "The identifier of this Network Element. Is unique within the source system.", "type": "string" }, "description": { "description": "The detailed description of this Network Element.", "type": "string" }, "ipAddress": { "description": "The management IP address of this Network Element.", "type": "string" }, "type": { "description": "The type of this Network Element.", "type": "string" }, "product": { "description": "The vendor product name of this Network Element.", "type": "string" }, "version": { "description": "The version of this Network Element.", "type": "string" }, "resyncState": { "type": "object", "allOf": [ { "title": "ResyncState", "description": "The resynchronization status of this Network Element.", "example": "done", "type": "string", "enum": [ "unknown", "inProgress", "done", "failed", "requested", "notAttempted" ] }, { "description": "The resynchronization status of this Network Element." } ] }, "managedState": { "type": "object", "allOf": [ { "title": "ManagedState", "description": "The management state of this Network Element.", "example": "managed", "type": "string", "enum": [ "unknown", "managed", "preprovisioned", "suspended", "failed" ] }, { "description": "The management state of this Network Element." } ] }, "longitude": { "description": "The longitude (in degrees) of this Network Element, if known. Min = -180, Max = 180", "type": "number" }, "latitude": { "description": "The latitude (in degrees) of this Network Element, if known. Min = -90, Max = 90", "type": "number" }, "location": { "description": "The location of this Network Element.", "type": "string" }, "topologyGroup": { "description": "The Fully Distinguished Name of the topology group that this Network Element belongs to, if any.", "type": "string" }, "adminState": { "type": "object", "allOf": [ { "title": "AdminState3", "description": "The administrative state of this Network Element. Refer to the X.731 standard.", "example": "unlocked", "type": "string", "enum": [ "unknown", "unlocked", "locked", "forcedLockout", "shuttingDown", "maintenance" ] }, { "description": "The administrative state of this Network Element. Refer to the X.731 standard." } ] }, "operState": { "type": "object", "allOf": [ { "title": "OperState3", "description": "The operational state of this Network Element. Refer to the X.731 standard.", "example": "enabled", "type": "string", "enum": [ "unknown", "enabled", "disabled" ] }, { "description": "The operational state of this Network Element. Refer to the X.731 standard." } ] }, "standbyState": { "type": "object", "allOf": [ { "title": "StandbyState3", "description": "The standby state of this Network Element. Refer to the X.731 standard.", "example": "providingService", "type": "string", "enum": [ "providingService", "standby" ] }, { "description": "The standby state of this Network Element. Refer to the X.731 standard." } ] }, "availabilityStates": { "description": "The availability states of this Network Element. Refer to the X.731 standard.", "type": "array", "items": { "title": "AvailabilityState", "type": "string", "enum": [ "unknown", "inTest", "failed", "degraded", "offLine", "powerOff", "offDuty", "dependency", "notInstalled", "logFull" ] } }, "objectDetails": { "description": "Generic properties of this Network Element, specific to the Network Supervision application.", "type": "object", "additionalProperties": { "type": "string" } }, "networkType": { "type": "object", "allOf": [ { "title": "NetworkType", "description": "The type of network this Network Element is part of.", "example": "ip", "type": "string", "enum": [ "ext", "unknown", "ip", "optical", "wireless" ] }, { "description": "The type of network this Network Element is part of." } ] }, "communicationState": { "type": "object", "allOf": [ { "title": "CommunicationState", "description": "The communication status of this Network Element. Specifies if the management system can reach the Network Element, using one of its supported management protocols.", "example": "up", "type": "string", "enum": [ "unknown", "up", "down", "partial" ] }, { "description": "The communication status of this Network Element. Specifies if the management system can reach the Network Element, using one of its supported management protocols." } ] }, "communicationStateDetails": { "description": "The reachability status of each supported management protocol of this Network Element.", "type": "object", "additionalProperties": { "title": "ReachabilityStatus", "type": "object", "properties": { "address": { "type": "string" }, "lastAttempt": { "type": "integer" }, "protocol": { "type": "string" }, "state": { "type": "string" } } } }, "macAddress": { "description": "The Mac address of this Network Element.", "type": "string" }, "clliCode": { "description": "Common Language Location Identifier (CLLI) code value for the system.", "type": "string" } }, "required": [ "fdn", "sourceType", "sourceSystem", "sources", "name", "neName", "neId", "ipAddress", "type", "product", "version", "resyncState", "managedState", "adminState", "operState", "standbyState", "communicationState" ] } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNEsUsingGET" }, "task": true }, { "name": "getNEUsingGET", "summary": "getNEUsingGET", "description": "Returns detailed information for the specified network element. Example: GET /v1/networkElements/fdn:model:equipment:NetworkElement:2102", "input": [ { "name": "networkElementFdn", "type": "string", "info": "networkElementFdn: string", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNEUsingGET" }, "task": true }, { "name": "getNELAGsUsingGET", "summary": "getNELAGsUsingGET", "description": "Returns a list of specific LAGs. The list will contain the FDN of each resulting LAG. Not providing a filter will return all LAGs. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The name of the LAG, as defined by the source system neName: The name of the LAG which is unique within the source system neId: The id of the LAG description: The deta...(description truncated)", "input": [ { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "networkElementFdn", "type": "string", "info": "networkElementFdn: string", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "LAG", "type": "object", "properties": { "links": { "xml": { "namespace": "http://www.w3.org/2005/Atom", "attribute": false, "wrapped": false }, "type": "array", "items": { "title": "Link", "type": "object", "properties": { "href": { "xml": { "name": "href", "attribute": true, "wrapped": false }, "type": "string" }, "rel": { "xml": { "name": "rel", "attribute": true, "wrapped": false }, "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "description": "The Fully Distinguished Name of this LAG.", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType3", "description": "The type of the source system where this LAG is sourced from.", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "description": "The type of the source system where this LAG is sourced from." } ] }, "sourceSystem": { "description": "The source system where this LAG is sourced from.", "type": "string" }, "sources": { "description": "The Fully Distinguished Names of the LAGs from the source system associated to this LAG.", "type": "array", "items": { "type": "string" } }, "lagId": { "description": "The short identifier of this LAG, as defined by the source system", "type": "string" }, "neName": { "description": "The name of this LAG. Is unique within the source system.", "type": "string" }, "neId": { "description": "The id of this LAG. Is unique within the source system.", "type": "string" }, "name": { "description": "The name of this LAG, as defined by the source system.", "type": "string" }, "description": { "description": "The detailed description of this LAG.", "type": "string" }, "configuredAddress": { "description": "The MAC Address of this LAG.", "type": "string" }, "encapType": { "type": "object", "allOf": [ { "title": "EncapType", "description": "The encapsulation type of this LAG.", "example": "nullEncap", "type": "string", "enum": [ "unknown", "other", "nullEncap", "dot1q", "qinq", "mpls", "bcpNull", "bcpDot1q", "ipcp", "frameRelay", "pppAuto", "atm", "wanMirror", "ciscoHdlc", "cem", "rhdlc", "raw", "cellular", "wlan" ] }, { "description": "The encapsulation type of this LAG." } ] }, "operationalSpeedUnits": { "description": "The units associated to the 'operationalSpeed' field value for this LAG.", "type": "string" }, "operationalSpeed": { "description": "The total operational speed of this LAG, in units specified by the 'operationalSpeedUnits' field value.", "type": "number" }, "lagMode": { "type": "object", "allOf": [ { "title": "LagMode", "description": "The mode of this LAG.", "example": "access", "type": "string", "enum": [ "undefined", "access", "trunk", "hybrid" ] }, { "description": "The mode of this LAG." } ] }, "adminState": { "type": "object", "allOf": [ { "title": "AdminState2", "description": "The administrative state of this LAG. Refer to the X.731 standard.", "example": "unlocked", "type": "string", "enum": [ "unknown", "unlocked", "locked", "forcedLockout", "shuttingDown", "maintenance" ] }, { "description": "The administrative state of this LAG. Refer to the X.731 standard." } ] }, "operState": { "type": "object", "allOf": [ { "title": "OperState2", "description": "The operational state of this LAG. Refer to the X.731 standard.", "example": "enabled", "type": "string", "enum": [ "unknown", "enabled", "disabled" ] }, { "description": "The operational state of this LAG. Refer to the X.731 standard." } ] }, "standbyState": { "type": "object", "allOf": [ { "title": "StandbyState2", "description": "The standby state of this LAG. Refer to the X.731 standard", "example": "providingService", "type": "string", "enum": [ "providingService", "standby" ] }, { "description": "The standby state of this LAG. Refer to the X.731 standard" } ] }, "availabilityStates": { "description": "The availability states of this LAG. Refer to the X.731 standard.", "type": "array", "items": { "title": "AvailabilityState", "type": "string", "enum": [ "unknown", "inTest", "failed", "degraded", "offLine", "powerOff", "offDuty", "dependency", "notInstalled", "logFull" ] } }, "stateReasons": { "description": "A set of specific reasons why the LAG is in this state.", "type": "array", "items": { "type": "string" } }, "objectDetails": { "description": "Generic properties of this LAG, specific to the Network Supervision application", "type": "object", "additionalProperties": { "type": "string" } }, "members": { "type": "array", "items": { "title": "LAGMemberDetails", "type": "object", "properties": { "encapType": { "type": "string" }, "fdn": { "type": "string" }, "lagId": { "type": "string" }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "portFdn": { "type": "string" }, "portName": { "type": "string" }, "priority": { "type": "integer" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" } } } }, "multiChassisLAGMembers": { "type": "array", "items": { "title": "MultiChassisLAGMember", "type": "object", "properties": { "description": { "type": "string" }, "fdn": { "type": "string" }, "lacpKey": { "type": "integer" }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "peerIpAddress": { "type": "string" }, "peerNeId": { "type": "string" }, "remoteLagId": { "type": "string" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" }, "systemId": { "type": "string" }, "systemPriority": { "type": "integer" } } } }, "parentNe": { "description": "The Fully Distinguished Name of the Network Element containing this LAG.", "type": "string" }, "parent": { "description": "The Fully Distinguished Name of the Radio Equipment containing this LAG.", "type": "string" } }, "required": [ "fdn", "sourceType", "sourceSystem", "sources", "lagId", "neName", "neId", "name", "encapType", "adminState", "operState", "standbyState", "parentNe" ] } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNELAGsUsingGET" }, "task": true }, { "name": "getLagMembersUsingGET", "summary": "getLagMembersUsingGET", "description": "Returns a list of specific LAG members. The list will contain the FDN of each resulting LAG member. Not providing a filter will return all LAG members. Examples:", "input": [ { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "lagFdn", "type": "string", "info": "lagFdn: string", "required": true, "schema": { "title": "lagFdn", "type": "string" } }, { "name": "networkElementFdn", "type": "string", "info": "networkElementFdn: string", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "LAGMemberDetails", "type": "object", "properties": { "encapType": { "type": "string" }, "fdn": { "type": "string" }, "lagId": { "type": "string" }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "portFdn": { "type": "string" }, "portName": { "type": "string" }, "priority": { "type": "integer" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getLagMembersUsingGET" }, "task": true }, { "name": "getNERadioEquipmentsUsingGET", "summary": "getNERadioEquipmentsUsingGET", "description": "Returns a list of specific radio equipments. The list will contain the FDN of each resulting Radio Equipment. Not providing a filter will return all Radio Equipments. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The name of the radio equipment, as defined by the source system neName: The name of the radio equipment which is unique within the sour...(description truncated)", "input": [ { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "networkElementFdn", "type": "string", "info": "networkElementFdn: string", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "RadioEquipment", "type": "object", "properties": { "adminState": { "type": "string" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "chassisType": { "type": "string" }, "clliCode": { "type": "string" }, "communicationState": { "type": "string" }, "description": { "type": "string" }, "fdn": { "type": "string" }, "ipAddress": { "type": "string" }, "latitude": { "type": "number" }, "links": { "xml": { "namespace": "http://www.w3.org/2005/Atom", "attribute": false, "wrapped": false }, "type": "array", "items": { "title": "Link", "type": "object", "properties": { "href": { "xml": { "name": "href", "attribute": true, "wrapped": false }, "type": "string" }, "rel": { "xml": { "name": "rel", "attribute": true, "wrapped": false }, "type": "string" }, "templated": { "type": "boolean" } } } }, "location": { "type": "string" }, "longitude": { "type": "number" }, "macAddress": { "type": "string" }, "managedState": { "type": "string" }, "name": { "type": "string" }, "neId": { "type": "string" }, "neName": { "type": "string" }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "operState": { "type": "string" }, "parentNeName": { "type": "string" }, "product": { "type": "string" }, "resyncState": { "type": "string" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" }, "systemAddress": { "type": "string" }, "version": { "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNERadioEquipmentsUsingGET" }, "task": true }, { "name": "getRadioEquipmentLagsUsingGET", "summary": "getRadioEquipmentLagsUsingGET", "description": "Returns a list of specific LAGs on a radio equipment linked to a network element. The list will contain the FDN of each resulting LAG. Not providing a filter will return all LAGs. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The user friendly visible name neName: The name of the LAG neId: The id of the LAG description: The detailed descripti...(description truncated)", "input": [ { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "networkElementFdn", "type": "string", "info": "networkElementFdn: string", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "radioEquipmentFdn", "type": "string", "info": "radioEquipmentFdn: string", "required": true, "schema": { "title": "radioEquipmentFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "LAG", "type": "object", "properties": { "links": { "xml": { "namespace": "http://www.w3.org/2005/Atom", "attribute": false, "wrapped": false }, "type": "array", "items": { "title": "Link", "type": "object", "properties": { "href": { "xml": { "name": "href", "attribute": true, "wrapped": false }, "type": "string" }, "rel": { "xml": { "name": "rel", "attribute": true, "wrapped": false }, "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "description": "The Fully Distinguished Name of this LAG.", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType3", "description": "The type of the source system where this LAG is sourced from.", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "description": "The type of the source system where this LAG is sourced from." } ] }, "sourceSystem": { "description": "The source system where this LAG is sourced from.", "type": "string" }, "sources": { "description": "The Fully Distinguished Names of the LAGs from the source system associated to this LAG.", "type": "array", "items": { "type": "string" } }, "lagId": { "description": "The short identifier of this LAG, as defined by the source system", "type": "string" }, "neName": { "description": "The name of this LAG. Is unique within the source system.", "type": "string" }, "neId": { "description": "The id of this LAG. Is unique within the source system.", "type": "string" }, "name": { "description": "The name of this LAG, as defined by the source system.", "type": "string" }, "description": { "description": "The detailed description of this LAG.", "type": "string" }, "configuredAddress": { "description": "The MAC Address of this LAG.", "type": "string" }, "encapType": { "type": "object", "allOf": [ { "title": "EncapType", "description": "The encapsulation type of this LAG.", "example": "nullEncap", "type": "string", "enum": [ "unknown", "other", "nullEncap", "dot1q", "qinq", "mpls", "bcpNull", "bcpDot1q", "ipcp", "frameRelay", "pppAuto", "atm", "wanMirror", "ciscoHdlc", "cem", "rhdlc", "raw", "cellular", "wlan" ] }, { "description": "The encapsulation type of this LAG." } ] }, "operationalSpeedUnits": { "description": "The units associated to the 'operationalSpeed' field value for this LAG.", "type": "string" }, "operationalSpeed": { "description": "The total operational speed of this LAG, in units specified by the 'operationalSpeedUnits' field value.", "type": "number" }, "lagMode": { "type": "object", "allOf": [ { "title": "LagMode", "description": "The mode of this LAG.", "example": "access", "type": "string", "enum": [ "undefined", "access", "trunk", "hybrid" ] }, { "description": "The mode of this LAG." } ] }, "adminState": { "type": "object", "allOf": [ { "title": "AdminState2", "description": "The administrative state of this LAG. Refer to the X.731 standard.", "example": "unlocked", "type": "string", "enum": [ "unknown", "unlocked", "locked", "forcedLockout", "shuttingDown", "maintenance" ] }, { "description": "The administrative state of this LAG. Refer to the X.731 standard." } ] }, "operState": { "type": "object", "allOf": [ { "title": "OperState2", "description": "The operational state of this LAG. Refer to the X.731 standard.", "example": "enabled", "type": "string", "enum": [ "unknown", "enabled", "disabled" ] }, { "description": "The operational state of this LAG. Refer to the X.731 standard." } ] }, "standbyState": { "type": "object", "allOf": [ { "title": "StandbyState2", "description": "The standby state of this LAG. Refer to the X.731 standard", "example": "providingService", "type": "string", "enum": [ "providingService", "standby" ] }, { "description": "The standby state of this LAG. Refer to the X.731 standard" } ] }, "availabilityStates": { "description": "The availability states of this LAG. Refer to the X.731 standard.", "type": "array", "items": { "title": "AvailabilityState", "type": "string", "enum": [ "unknown", "inTest", "failed", "degraded", "offLine", "powerOff", "offDuty", "dependency", "notInstalled", "logFull" ] } }, "stateReasons": { "description": "A set of specific reasons why the LAG is in this state.", "type": "array", "items": { "type": "string" } }, "objectDetails": { "description": "Generic properties of this LAG, specific to the Network Supervision application", "type": "object", "additionalProperties": { "type": "string" } }, "members": { "type": "array", "items": { "title": "LAGMemberDetails", "type": "object", "properties": { "encapType": { "type": "string" }, "fdn": { "type": "string" }, "lagId": { "type": "string" }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "portFdn": { "type": "string" }, "portName": { "type": "string" }, "priority": { "type": "integer" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" } } } }, "multiChassisLAGMembers": { "type": "array", "items": { "title": "MultiChassisLAGMember", "type": "object", "properties": { "description": { "type": "string" }, "fdn": { "type": "string" }, "lacpKey": { "type": "integer" }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "peerIpAddress": { "type": "string" }, "peerNeId": { "type": "string" }, "remoteLagId": { "type": "string" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" }, "systemId": { "type": "string" }, "systemPriority": { "type": "integer" } } } }, "parentNe": { "description": "The Fully Distinguished Name of the Network Element containing this LAG.", "type": "string" }, "parent": { "description": "The Fully Distinguished Name of the Radio Equipment containing this LAG.", "type": "string" } }, "required": [ "fdn", "sourceType", "sourceSystem", "sources", "lagId", "neName", "neId", "name", "encapType", "adminState", "operState", "standbyState", "parentNe" ] } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRadioEquipmentLagsUsingGET" }, "task": true }, { "name": "getRadioEquipmentLagMembersUsingGET", "summary": "getRadioEquipmentLagMembersUsingGET", "description": "Returns a list of specific LAG members a radio equipment LAG. The list will contain the FDN of each resulting LAG member. Not providing a filter will return all LAG members. Examples:", "input": [ { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "lagFdn", "type": "string", "info": "lagFdn: string", "required": true, "schema": { "title": "lagFdn", "type": "string" } }, { "name": "networkElementFdn", "type": "string", "info": "networkElementFdn: string", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "radioEquipmentFdn", "type": "string", "info": "radioEquipmentFdn: string", "required": true, "schema": { "title": "radioEquipmentFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "LAGMemberDetails", "type": "object", "properties": { "encapType": { "type": "string" }, "fdn": { "type": "string" }, "lagId": { "type": "string" }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "portFdn": { "type": "string" }, "portName": { "type": "string" }, "priority": { "type": "integer" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRadioEquipmentLagMembersUsingGET" }, "task": true }, { "name": "getRadioEquipmentShelvesUsingGET", "summary": "getRadioEquipmentShelvesUsingGET", "description": "Returns a list of specific shelves on a radio equipment linked to a network element. The list will contain the FDN of each resulting shelf. Not providing a filter will return all shelves. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The user friendly visible name neName: The name of the radio equipment containing the Shelf neId: The id of the ...(description truncated)", "input": [ { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "networkElementFdn", "type": "string", "info": "networkElementFdn: string", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "radioEquipmentFdn", "type": "string", "info": "radioEquipmentFdn: string", "required": true, "schema": { "title": "radioEquipmentFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "Shelf", "type": "object", "properties": { "links": { "xml": { "namespace": "http://www.w3.org/2005/Atom", "attribute": false, "wrapped": false }, "type": "array", "items": { "title": "Link", "type": "object", "properties": { "href": { "xml": { "name": "href", "attribute": true, "wrapped": false }, "type": "string" }, "rel": { "xml": { "name": "rel", "attribute": true, "wrapped": false }, "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "description": "The Fully Distinguished Name of this Shelf.", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType7", "description": "The type of the source system where this Shelf is sourced from.", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "description": "The type of the source system where this Shelf is sourced from." } ] }, "sourceSystem": { "description": "The source system where this Shelf is sourced from.", "type": "string" }, "sources": { "description": "The Fully Distinguished Names of the Shelves from the source system associated to this Shelf.", "type": "array", "items": { "type": "string" } }, "name": { "description": "The name of this Shelf, as defined by the source system.", "type": "string" }, "neName": { "description": "The name of the Network Element containing this Shelf, as defined by the source system.", "type": "string" }, "neId": { "description": "The id of the Network Element containing this Shelf, as defined by the source system.", "type": "string" }, "description": { "description": "The detailed description of this Shelf.", "type": "string" }, "positionId": { "description": "The relative position of the Shelf, that determines the order in which to show it in the source system UI.", "type": "integer" }, "position": { "description": "A formatted name that describes the position of the Shelf within the Network Element.", "type": "string" }, "adminState": { "type": "object", "allOf": [ { "title": "AdminState6", "description": "The administrative state of this Shelf. Refer to the X.731 standard.", "example": "unlocked", "type": "string", "enum": [ "unknown", "unlocked", "locked", "forcedLockout", "shuttingDown", "maintenance" ] }, { "description": "The administrative state of this Shelf. Refer to the X.731 standard." } ] }, "operState": { "type": "object", "allOf": [ { "title": "OperState6", "description": "The operational state of this Shelf. Refer to the X.731 standard.", "example": "enabled", "type": "string", "enum": [ "unknown", "enabled", "disabled" ] }, { "description": "The operational state of this Shelf. Refer to the X.731 standard." } ] }, "standbyState": { "type": "object", "allOf": [ { "title": "StandbyState6", "description": "The standby state of this Shelf. Refer to the X.731 standard.", "example": "providingService", "type": "string", "enum": [ "providingService", "standby" ] }, { "description": "The standby state of this Shelf. Refer to the X.731 standard." } ] }, "availabilityStates": { "description": "The availability states of this Shelf. Refer to the X.731 standard.", "type": "array", "items": { "title": "AvailabilityState", "type": "string", "enum": [ "unknown", "inTest", "failed", "degraded", "offLine", "powerOff", "offDuty", "dependency", "notInstalled", "logFull" ] } }, "stateReasons": { "description": "A set of specific reasons why the Shelf is in this state.", "type": "array", "items": { "type": "string" } }, "objectDetails": { "description": "Generic properties of this Shelf, specific to the Network Supervision application.", "type": "object", "additionalProperties": { "type": "string" } }, "manufacturer": { "description": "The vendor of the Shelf.", "type": "string" }, "serialNumber": { "description": "The serial number of the Shelf provided by the manufacturer.", "type": "string" }, "partNumber": { "description": "The part number of the Shelf provided by the manufacturer.", "type": "string" }, "manufacturerAssemblyNumber": { "description": "The assembly number of the Shelf provided by the manufacturer.", "type": "string" }, "manufactureDate": { "description": "The date of manufacture of the Shelf.", "type": "string" }, "manufacturingDeviations": { "description": "The manufacturing deviations of the Shelf provided by the manufacturer.", "type": "string" }, "macAddress": { "description": "The Base MAC Address of the Shelf", "type": "string" }, "hwMacAddress": { "description": "The Hardware MAC Address of the Shelf", "type": "string" } }, "required": [ "fdn", "sourceType", "sourceSystem", "sources", "name", "neName", "neId", "positionId", "position", "adminState", "operState", "standbyState", "availabilityStates" ] } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRadioEquipmentShelvesUsingGET" }, "task": true }, { "name": "getRadioEquipmentShelfCardsUsingGET", "summary": "getRadioEquipmentShelfCardsUsingGET", "description": "Returns a list of specific cards on a radio equipment shelf. The list will contain the FDN of each resulting card. Not providing a filter will return all cards. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The user friendly visible name neName: The name of the Network Element containing the Card neId: The id of the Network Element containing t...(description truncated)", "input": [ { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "networkElementFdn", "type": "string", "info": "networkElementFdn: string", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "radioEquipmentFdn", "type": "string", "info": "radioEquipmentFdn: string", "required": true, "schema": { "title": "radioEquipmentFdn", "type": "string" } }, { "name": "shelfFdn", "type": "string", "info": "shelfFdn: string", "required": true, "schema": { "title": "shelfFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "Card", "type": "object", "properties": { "links": { "xml": { "namespace": "http://www.w3.org/2005/Atom", "attribute": false, "wrapped": false }, "type": "array", "items": { "title": "Link", "type": "object", "properties": { "href": { "xml": { "name": "href", "attribute": true, "wrapped": false }, "type": "string" }, "rel": { "xml": { "name": "rel", "attribute": true, "wrapped": false }, "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "description": "The Fully Distinguished Name of this Card.", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType", "description": "The type of the source system where this Card is sourced from.", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "description": "The type of the source system where this Card is sourced from." } ] }, "sourceSystem": { "description": "The source system where this Card is sourced from.", "type": "string" }, "sources": { "description": "The Fully Distinguished Names of the Cards from the source system associated to this Card.", "type": "array", "items": { "type": "string" } }, "name": { "description": "The name of this Card, as defined by the source system.", "type": "string" }, "neName": { "description": "The name of the Network Element containing this Card, as defined by the source system.", "type": "string" }, "neId": { "description": "The id of the Network Element containing this Card, as defined by the source system.", "type": "string" }, "description": { "description": "The detailed description of this Card.", "type": "string" }, "positionId": { "description": "The relative position of the Card, that determines the order in which to show it in the source system UI.", "type": "integer" }, "position": { "description": "A formatted name that describes the position of the Card within the Network Element.", "type": "string" }, "adminState": { "type": "object", "allOf": [ { "title": "AdminState", "description": "The administrative state of this Card. Refer to the X.731 standard.", "example": "unlocked", "type": "string", "enum": [ "unknown", "unlocked", "locked", "forcedLockout", "shuttingDown", "maintenance" ] }, { "description": "The administrative state of this Card. Refer to the X.731 standard." } ] }, "operState": { "type": "object", "allOf": [ { "title": "OperState", "description": "The operational state of this Card. Refer to the X.731 standard.", "example": "enabled", "type": "string", "enum": [ "unknown", "enabled", "disabled" ] }, { "description": "The operational state of this Card. Refer to the X.731 standard." } ] }, "standbyState": { "type": "object", "allOf": [ { "title": "StandbyState", "description": "The standby state of this Card. Refer to the X.731 standard.", "example": "providingService", "type": "string", "enum": [ "providingService", "standby" ] }, { "description": "The standby state of this Card. Refer to the X.731 standard." } ] }, "availabilityStates": { "description": "The availability states of this Card. Refer to the X.731 standard.", "type": "array", "items": { "title": "AvailabilityState", "type": "string", "enum": [ "unknown", "inTest", "failed", "degraded", "offLine", "powerOff", "offDuty", "dependency", "notInstalled", "logFull" ] } }, "stateReasons": { "description": "A set of specific reasons why the Card is in this state.", "type": "array", "items": { "type": "string" } }, "objectDetails": { "description": "Generic properties of this Card, specific to the Network Supervision application.", "type": "object", "additionalProperties": { "type": "string" } }, "manufacturer": { "description": "The vendor of the Card.", "type": "string" }, "serialNumber": { "description": "The serial number of the Card provided by the manufacturer.", "type": "string" }, "partNumber": { "description": "The part number of the Card provided by the manufacturer.", "type": "string" }, "manufacturerAssemblyNumber": { "description": "The assembly number of the Card provided by the manufacturer.", "type": "string" }, "manufactureDate": { "description": "The date of manufacture of the Card.", "type": "string" }, "manufacturingDeviations": { "description": "The manufacturing deviations of the Card provided by the manufacturer.", "type": "string" }, "macAddress": { "description": "The Base MAC Address of the Card", "type": "string" }, "hwMacAddress": { "description": "The Hardware MAC Address of the Card", "type": "string" }, "cardDetails": { "title": "CardDetails", "type": "object", "properties": { "fdn": { "example": "fdn:model:equipment:CardDetails:2203", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType1", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "example": "nfmp" } ] }, "sourceSystem": { "example": "fdn:realm:sam", "type": "string" }, "sources": { "example": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card@cardDetails" ], "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "cardType": { "description": "The type of this Card.", "example": "500g CPM / Switch Fabric 3", "type": "string" }, "equippedPorts": { "description": "The number of ports equipped directly on this Card.", "example": 40, "type": "integer" }, "capabilities": { "description": "A set of specific capabilities of the Card.", "type": "array", "items": { "type": "string" } }, "availableSlots": { "description": "The number of available card slots on this Card.", "example": 2, "type": "integer" }, "installedSlots": { "description": "The number of installed slots on this Card.", "example": 1, "type": "integer" }, "memorySize": { "description": "The Memory Size of this Card in MB.", "example": 16392, "type": "integer" }, "lastBootUpReason": { "description": "The last boot-up reason of this Card.", "example": "Hard Reboot", "type": "string" } } } }, "required": [ "fdn", "sourceType", "sourceSystem", "sources", "name", "neName", "neId", "positionId", "position", "adminState", "operState", "standbyState", "availabilityStates" ] } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRadioEquipmentShelfCardsUsingGET" }, "task": true }, { "name": "getRadioEquipmentCardPortsUsingGET", "summary": "getRadioEquipmentCardPortsUsingGET", "description": "Returns a list of specific ports on a radio equipment card. The list will contain the FDN of each resulting port. Not providing a filter will return all ports. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The user friendly visible name neName: The name of the Network Element containing the Port neId: The id of the Network Element containing th...(description truncated)", "input": [ { "name": "cardFdn", "type": "string", "info": "cardFdn: string", "required": true, "schema": { "title": "cardFdn", "type": "string" } }, { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "networkElementFdn", "type": "string", "info": "networkElementFdn: string", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "radioEquipmentFdn", "type": "string", "info": "radioEquipmentFdn: string", "required": true, "schema": { "title": "radioEquipmentFdn", "type": "string" } }, { "name": "shelfFdn", "type": "string", "info": "shelfFdn: string", "required": true, "schema": { "title": "shelfFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "Port", "type": "object", "properties": { "links": { "xml": { "namespace": "http://www.w3.org/2005/Atom", "attribute": false, "wrapped": false }, "type": "array", "items": { "title": "Link", "type": "object", "properties": { "href": { "xml": { "name": "href", "attribute": true, "wrapped": false }, "type": "string" }, "rel": { "xml": { "name": "rel", "attribute": true, "wrapped": false }, "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "description": "The Fully Distinguished Name of this Port.", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType5", "description": "The type of the source system where this Port is sourced from.", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "description": "The type of the source system where this Port is sourced from." } ] }, "sourceSystem": { "description": "The source system where this Port is sourced from.", "type": "string" }, "sources": { "description": "The Fully Distinguished Names of the Ports from the source system associated to this Port.", "type": "array", "items": { "type": "string" } }, "name": { "description": "The name of this Port, as defined by the source system.", "type": "string" }, "neName": { "description": "The name of the Network Element containing this Port, as defined by the source system.", "type": "string" }, "neId": { "description": "The id of the Network Element containing this Port, as defined by the source system.", "type": "string" }, "description": { "description": "The detailed description of this Port.", "type": "string" }, "positionId": { "description": "The relative position of the Port, that determines the order in which to show it in the source system UI.", "type": "integer" }, "position": { "description": "A formatted name that describes the position of the Port within the Network Element.", "type": "string" }, "adminState": { "type": "object", "allOf": [ { "title": "AdminState5", "description": "The administrative state of this Port. Refer to the X.731 standard.", "example": "unlocked", "type": "string", "enum": [ "unknown", "unlocked", "locked", "forcedLockout", "shuttingDown", "maintenance" ] }, { "description": "The administrative state of this Port. Refer to the X.731 standard." } ] }, "operState": { "type": "object", "allOf": [ { "title": "OperState5", "description": "The operational state of this Port. Refer to the X.731 standard.", "example": "enabled", "type": "string", "enum": [ "unknown", "enabled", "disabled" ] }, { "description": "The operational state of this Port. Refer to the X.731 standard." } ] }, "standbyState": { "type": "object", "allOf": [ { "title": "StandbyState5", "description": "The standby state of this Port. Refer to the X.731 standard.", "example": "providingService", "type": "string", "enum": [ "providingService", "standby" ] }, { "description": "The standby state of this Port. Refer to the X.731 standard." } ] }, "availabilityStates": { "description": "The availability states of this Port. Refer to the X.731 standard.", "type": "array", "items": { "title": "AvailabilityState", "type": "string", "enum": [ "unknown", "inTest", "failed", "degraded", "offLine", "powerOff", "offDuty", "dependency", "notInstalled", "logFull" ] } }, "stateReasons": { "description": "A set of specific reasons why the Port is in this state.", "type": "array", "items": { "type": "string" } }, "objectDetails": { "description": "Generic properties of this Port, specific to the Network Supervision application.", "type": "object", "additionalProperties": { "type": "string" } }, "manufacturer": { "description": "The vendor of the Port.", "type": "string" }, "serialNumber": { "description": "The serial number of the Port provided by the manufacturer.", "type": "string" }, "partNumber": { "description": "The part number of the Port provided by the manufacturer.", "type": "string" }, "manufacturerAssemblyNumber": { "description": "The assembly number of the Port provided by the manufacturer.", "type": "string" }, "manufactureDate": { "description": "The date of manufacture of the Port.", "type": "string" }, "manufacturingDeviations": { "description": "The manufacturing deviations of the Port provided by the manufacturer.", "type": "string" }, "macAddress": { "description": "The Configured MAC Address of the Port", "type": "string" }, "hwMacAddress": { "description": "The Hardware MAC Address of the Port", "type": "string" }, "portDetails": { "title": "PortDetails", "type": "object", "properties": { "fdn": { "example": "fdn:model:equipment:PortDetails:2209", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType1", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "example": "nfmp" } ] }, "sourceSystem": { "example": "fdn:realm:sam", "type": "string" }, "sources": { "example": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card:port-1@portDetails" ], "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "portIndex": { "description": "The index of this Port. Generally, this is the SNMP 'ifIndex', if available.", "example": 67141632, "type": "integer" }, "portType": { "type": "object", "allOf": [ { "title": "PortType", "description": "The type of this Port.", "example": "ethernet", "type": "string", "enum": [ "ext", "unknown", "none", "other", "ethernet", "sonet", "virtual", "sonetChannel", "tdm", "radio", "wireless", "serial", "voice", "wdm", "gpon", "dsl", "otu", "sdh", "connector", "coherentOptical", "otClient", "otLine" ] }, { "description": "The type of this Port.", "example": "ethernet" } ] }, "rate": { "description": "The rate label of this Port.", "example": "ethernet100", "type": "string" }, "actualRateUnits": { "type": "object", "allOf": [ { "title": "ActualRateUnits1", "description": "The units associated to the 'actualRate' field value for this Port.", "example": "kbps", "type": "string", "enum": [ "unknown", "kbps", "Mbps" ] }, { "description": "The units associated to the 'actualRate' field value for this Port.", "example": "kbps" } ] }, "actualRate": { "description": "The rate of this Port, in units specified by the 'actualRateUnits' field value.", "example": 100000, "type": "number" }, "portMode": { "type": "object", "allOf": [ { "title": "PortMode", "description": "The mode of port.", "example": "access", "type": "string", "enum": [ "undefined", "access", "trunk", "hybrid" ] }, { "description": "The mode of port.", "example": "access" } ] }, "encapType": { "type": "object", "allOf": [ { "title": "EncapType1", "description": "The Encapsulation type of the port", "example": "dot1q", "type": "string", "enum": [ "unknown", "other", "nullEncap", "dot1q", "qinq", "mpls", "bcpNull", "bcpDot1q", "ipcp", "frameRelay", "pppAuto", "atm", "wanMirror", "ciscoHdlc", "cem", "rhdlc", "raw", "cellular", "wlan" ] }, { "description": "The Encapsulation type of the port", "example": "dot1q" } ] }, "mtuValue": { "description": "The MTU value of the port in bytes.", "example": 1578, "type": "integer" } }, "required": [ "portMode" ] }, "lagDetails": { "title": "LAGMemberDetails", "type": "object", "properties": { "encapType": { "type": "string" }, "fdn": { "type": "string" }, "lagId": { "type": "string" }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "portFdn": { "type": "string" }, "portName": { "type": "string" }, "priority": { "type": "integer" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" } } } }, "required": [ "fdn", "sourceType", "sourceSystem", "sources", "name", "neName", "neId", "positionId", "position", "adminState", "operState", "standbyState", "availabilityStates" ] } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRadioEquipmentCardPortsUsingGET" }, "task": true }, { "name": "getNEShelvesUsingGET", "summary": "getNEShelvesUsingGET", "description": "Returns a list of specific shelves. The list will contain the FDN of each resulting shelf. Not providing a filter will return all shelves. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The user friendly visible name neName: The name of the Network Element containing the Shelf neId: The id of the Network Element containing the Shelf descriptio...(description truncated)", "input": [ { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "networkElementFdn", "type": "string", "info": "networkElementFdn: string", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "Shelf", "type": "object", "properties": { "links": { "xml": { "namespace": "http://www.w3.org/2005/Atom", "attribute": false, "wrapped": false }, "type": "array", "items": { "title": "Link", "type": "object", "properties": { "href": { "xml": { "name": "href", "attribute": true, "wrapped": false }, "type": "string" }, "rel": { "xml": { "name": "rel", "attribute": true, "wrapped": false }, "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "description": "The Fully Distinguished Name of this Shelf.", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType7", "description": "The type of the source system where this Shelf is sourced from.", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "description": "The type of the source system where this Shelf is sourced from." } ] }, "sourceSystem": { "description": "The source system where this Shelf is sourced from.", "type": "string" }, "sources": { "description": "The Fully Distinguished Names of the Shelves from the source system associated to this Shelf.", "type": "array", "items": { "type": "string" } }, "name": { "description": "The name of this Shelf, as defined by the source system.", "type": "string" }, "neName": { "description": "The name of the Network Element containing this Shelf, as defined by the source system.", "type": "string" }, "neId": { "description": "The id of the Network Element containing this Shelf, as defined by the source system.", "type": "string" }, "description": { "description": "The detailed description of this Shelf.", "type": "string" }, "positionId": { "description": "The relative position of the Shelf, that determines the order in which to show it in the source system UI.", "type": "integer" }, "position": { "description": "A formatted name that describes the position of the Shelf within the Network Element.", "type": "string" }, "adminState": { "type": "object", "allOf": [ { "title": "AdminState6", "description": "The administrative state of this Shelf. Refer to the X.731 standard.", "example": "unlocked", "type": "string", "enum": [ "unknown", "unlocked", "locked", "forcedLockout", "shuttingDown", "maintenance" ] }, { "description": "The administrative state of this Shelf. Refer to the X.731 standard." } ] }, "operState": { "type": "object", "allOf": [ { "title": "OperState6", "description": "The operational state of this Shelf. Refer to the X.731 standard.", "example": "enabled", "type": "string", "enum": [ "unknown", "enabled", "disabled" ] }, { "description": "The operational state of this Shelf. Refer to the X.731 standard." } ] }, "standbyState": { "type": "object", "allOf": [ { "title": "StandbyState6", "description": "The standby state of this Shelf. Refer to the X.731 standard.", "example": "providingService", "type": "string", "enum": [ "providingService", "standby" ] }, { "description": "The standby state of this Shelf. Refer to the X.731 standard." } ] }, "availabilityStates": { "description": "The availability states of this Shelf. Refer to the X.731 standard.", "type": "array", "items": { "title": "AvailabilityState", "type": "string", "enum": [ "unknown", "inTest", "failed", "degraded", "offLine", "powerOff", "offDuty", "dependency", "notInstalled", "logFull" ] } }, "stateReasons": { "description": "A set of specific reasons why the Shelf is in this state.", "type": "array", "items": { "type": "string" } }, "objectDetails": { "description": "Generic properties of this Shelf, specific to the Network Supervision application.", "type": "object", "additionalProperties": { "type": "string" } }, "manufacturer": { "description": "The vendor of the Shelf.", "type": "string" }, "serialNumber": { "description": "The serial number of the Shelf provided by the manufacturer.", "type": "string" }, "partNumber": { "description": "The part number of the Shelf provided by the manufacturer.", "type": "string" }, "manufacturerAssemblyNumber": { "description": "The assembly number of the Shelf provided by the manufacturer.", "type": "string" }, "manufactureDate": { "description": "The date of manufacture of the Shelf.", "type": "string" }, "manufacturingDeviations": { "description": "The manufacturing deviations of the Shelf provided by the manufacturer.", "type": "string" }, "macAddress": { "description": "The Base MAC Address of the Shelf", "type": "string" }, "hwMacAddress": { "description": "The Hardware MAC Address of the Shelf", "type": "string" } }, "required": [ "fdn", "sourceType", "sourceSystem", "sources", "name", "neName", "neId", "positionId", "position", "adminState", "operState", "standbyState", "availabilityStates" ] } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNEShelvesUsingGET" }, "task": true }, { "name": "getShelfCardsUsingGET", "summary": "getShelfCardsUsingGET", "description": "Returns a list of specific cards. The list will contain the FDN of each resulting card. Not providing a filter will return all cards. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The user friendly visible name neName: The name of the Network Element containing the Card neId: The id of the Network Element containing the Card description: The...(description truncated)", "input": [ { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "networkElementFdn", "type": "string", "info": "networkElementFdn: string", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "shelfFdn", "type": "string", "info": "shelfFdn: string", "required": true, "schema": { "title": "shelfFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "Card", "type": "object", "properties": { "links": { "xml": { "namespace": "http://www.w3.org/2005/Atom", "attribute": false, "wrapped": false }, "type": "array", "items": { "title": "Link", "type": "object", "properties": { "href": { "xml": { "name": "href", "attribute": true, "wrapped": false }, "type": "string" }, "rel": { "xml": { "name": "rel", "attribute": true, "wrapped": false }, "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "description": "The Fully Distinguished Name of this Card.", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType", "description": "The type of the source system where this Card is sourced from.", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "description": "The type of the source system where this Card is sourced from." } ] }, "sourceSystem": { "description": "The source system where this Card is sourced from.", "type": "string" }, "sources": { "description": "The Fully Distinguished Names of the Cards from the source system associated to this Card.", "type": "array", "items": { "type": "string" } }, "name": { "description": "The name of this Card, as defined by the source system.", "type": "string" }, "neName": { "description": "The name of the Network Element containing this Card, as defined by the source system.", "type": "string" }, "neId": { "description": "The id of the Network Element containing this Card, as defined by the source system.", "type": "string" }, "description": { "description": "The detailed description of this Card.", "type": "string" }, "positionId": { "description": "The relative position of the Card, that determines the order in which to show it in the source system UI.", "type": "integer" }, "position": { "description": "A formatted name that describes the position of the Card within the Network Element.", "type": "string" }, "adminState": { "type": "object", "allOf": [ { "title": "AdminState", "description": "The administrative state of this Card. Refer to the X.731 standard.", "example": "unlocked", "type": "string", "enum": [ "unknown", "unlocked", "locked", "forcedLockout", "shuttingDown", "maintenance" ] }, { "description": "The administrative state of this Card. Refer to the X.731 standard." } ] }, "operState": { "type": "object", "allOf": [ { "title": "OperState", "description": "The operational state of this Card. Refer to the X.731 standard.", "example": "enabled", "type": "string", "enum": [ "unknown", "enabled", "disabled" ] }, { "description": "The operational state of this Card. Refer to the X.731 standard." } ] }, "standbyState": { "type": "object", "allOf": [ { "title": "StandbyState", "description": "The standby state of this Card. Refer to the X.731 standard.", "example": "providingService", "type": "string", "enum": [ "providingService", "standby" ] }, { "description": "The standby state of this Card. Refer to the X.731 standard." } ] }, "availabilityStates": { "description": "The availability states of this Card. Refer to the X.731 standard.", "type": "array", "items": { "title": "AvailabilityState", "type": "string", "enum": [ "unknown", "inTest", "failed", "degraded", "offLine", "powerOff", "offDuty", "dependency", "notInstalled", "logFull" ] } }, "stateReasons": { "description": "A set of specific reasons why the Card is in this state.", "type": "array", "items": { "type": "string" } }, "objectDetails": { "description": "Generic properties of this Card, specific to the Network Supervision application.", "type": "object", "additionalProperties": { "type": "string" } }, "manufacturer": { "description": "The vendor of the Card.", "type": "string" }, "serialNumber": { "description": "The serial number of the Card provided by the manufacturer.", "type": "string" }, "partNumber": { "description": "The part number of the Card provided by the manufacturer.", "type": "string" }, "manufacturerAssemblyNumber": { "description": "The assembly number of the Card provided by the manufacturer.", "type": "string" }, "manufactureDate": { "description": "The date of manufacture of the Card.", "type": "string" }, "manufacturingDeviations": { "description": "The manufacturing deviations of the Card provided by the manufacturer.", "type": "string" }, "macAddress": { "description": "The Base MAC Address of the Card", "type": "string" }, "hwMacAddress": { "description": "The Hardware MAC Address of the Card", "type": "string" }, "cardDetails": { "title": "CardDetails", "type": "object", "properties": { "fdn": { "example": "fdn:model:equipment:CardDetails:2203", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType1", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "example": "nfmp" } ] }, "sourceSystem": { "example": "fdn:realm:sam", "type": "string" }, "sources": { "example": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card@cardDetails" ], "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "cardType": { "description": "The type of this Card.", "example": "500g CPM / Switch Fabric 3", "type": "string" }, "equippedPorts": { "description": "The number of ports equipped directly on this Card.", "example": 40, "type": "integer" }, "capabilities": { "description": "A set of specific capabilities of the Card.", "type": "array", "items": { "type": "string" } }, "availableSlots": { "description": "The number of available card slots on this Card.", "example": 2, "type": "integer" }, "installedSlots": { "description": "The number of installed slots on this Card.", "example": 1, "type": "integer" }, "memorySize": { "description": "The Memory Size of this Card in MB.", "example": 16392, "type": "integer" }, "lastBootUpReason": { "description": "The last boot-up reason of this Card.", "example": "Hard Reboot", "type": "string" } } } }, "required": [ "fdn", "sourceType", "sourceSystem", "sources", "name", "neName", "neId", "positionId", "position", "adminState", "operState", "standbyState", "availabilityStates" ] } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getShelfCardsUsingGET" }, "task": true }, { "name": "getCardPortsUsingGET", "summary": "getCardPortsUsingGET", "description": "Returns a list of specific ports. The list will contain the FDN of each resulting port. Not providing a filter will return all ports. Examples:", "input": [ { "name": "cardFdn", "type": "string", "info": "cardFdn: string", "required": true, "schema": { "title": "cardFdn", "type": "string" } }, { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "networkElementFdn", "type": "string", "info": "networkElementFdn: string", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "shelfFdn", "type": "string", "info": "shelfFdn: string", "required": true, "schema": { "title": "shelfFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "Port", "type": "object", "properties": { "links": { "xml": { "namespace": "http://www.w3.org/2005/Atom", "attribute": false, "wrapped": false }, "type": "array", "items": { "title": "Link", "type": "object", "properties": { "href": { "xml": { "name": "href", "attribute": true, "wrapped": false }, "type": "string" }, "rel": { "xml": { "name": "rel", "attribute": true, "wrapped": false }, "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "description": "The Fully Distinguished Name of this Port.", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType5", "description": "The type of the source system where this Port is sourced from.", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "description": "The type of the source system where this Port is sourced from." } ] }, "sourceSystem": { "description": "The source system where this Port is sourced from.", "type": "string" }, "sources": { "description": "The Fully Distinguished Names of the Ports from the source system associated to this Port.", "type": "array", "items": { "type": "string" } }, "name": { "description": "The name of this Port, as defined by the source system.", "type": "string" }, "neName": { "description": "The name of the Network Element containing this Port, as defined by the source system.", "type": "string" }, "neId": { "description": "The id of the Network Element containing this Port, as defined by the source system.", "type": "string" }, "description": { "description": "The detailed description of this Port.", "type": "string" }, "positionId": { "description": "The relative position of the Port, that determines the order in which to show it in the source system UI.", "type": "integer" }, "position": { "description": "A formatted name that describes the position of the Port within the Network Element.", "type": "string" }, "adminState": { "type": "object", "allOf": [ { "title": "AdminState5", "description": "The administrative state of this Port. Refer to the X.731 standard.", "example": "unlocked", "type": "string", "enum": [ "unknown", "unlocked", "locked", "forcedLockout", "shuttingDown", "maintenance" ] }, { "description": "The administrative state of this Port. Refer to the X.731 standard." } ] }, "operState": { "type": "object", "allOf": [ { "title": "OperState5", "description": "The operational state of this Port. Refer to the X.731 standard.", "example": "enabled", "type": "string", "enum": [ "unknown", "enabled", "disabled" ] }, { "description": "The operational state of this Port. Refer to the X.731 standard." } ] }, "standbyState": { "type": "object", "allOf": [ { "title": "StandbyState5", "description": "The standby state of this Port. Refer to the X.731 standard.", "example": "providingService", "type": "string", "enum": [ "providingService", "standby" ] }, { "description": "The standby state of this Port. Refer to the X.731 standard." } ] }, "availabilityStates": { "description": "The availability states of this Port. Refer to the X.731 standard.", "type": "array", "items": { "title": "AvailabilityState", "type": "string", "enum": [ "unknown", "inTest", "failed", "degraded", "offLine", "powerOff", "offDuty", "dependency", "notInstalled", "logFull" ] } }, "stateReasons": { "description": "A set of specific reasons why the Port is in this state.", "type": "array", "items": { "type": "string" } }, "objectDetails": { "description": "Generic properties of this Port, specific to the Network Supervision application.", "type": "object", "additionalProperties": { "type": "string" } }, "manufacturer": { "description": "The vendor of the Port.", "type": "string" }, "serialNumber": { "description": "The serial number of the Port provided by the manufacturer.", "type": "string" }, "partNumber": { "description": "The part number of the Port provided by the manufacturer.", "type": "string" }, "manufacturerAssemblyNumber": { "description": "The assembly number of the Port provided by the manufacturer.", "type": "string" }, "manufactureDate": { "description": "The date of manufacture of the Port.", "type": "string" }, "manufacturingDeviations": { "description": "The manufacturing deviations of the Port provided by the manufacturer.", "type": "string" }, "macAddress": { "description": "The Configured MAC Address of the Port", "type": "string" }, "hwMacAddress": { "description": "The Hardware MAC Address of the Port", "type": "string" }, "portDetails": { "title": "PortDetails", "type": "object", "properties": { "fdn": { "example": "fdn:model:equipment:PortDetails:2209", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType1", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "example": "nfmp" } ] }, "sourceSystem": { "example": "fdn:realm:sam", "type": "string" }, "sources": { "example": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card:port-1@portDetails" ], "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "portIndex": { "description": "The index of this Port. Generally, this is the SNMP 'ifIndex', if available.", "example": 67141632, "type": "integer" }, "portType": { "type": "object", "allOf": [ { "title": "PortType", "description": "The type of this Port.", "example": "ethernet", "type": "string", "enum": [ "ext", "unknown", "none", "other", "ethernet", "sonet", "virtual", "sonetChannel", "tdm", "radio", "wireless", "serial", "voice", "wdm", "gpon", "dsl", "otu", "sdh", "connector", "coherentOptical", "otClient", "otLine" ] }, { "description": "The type of this Port.", "example": "ethernet" } ] }, "rate": { "description": "The rate label of this Port.", "example": "ethernet100", "type": "string" }, "actualRateUnits": { "type": "object", "allOf": [ { "title": "ActualRateUnits1", "description": "The units associated to the 'actualRate' field value for this Port.", "example": "kbps", "type": "string", "enum": [ "unknown", "kbps", "Mbps" ] }, { "description": "The units associated to the 'actualRate' field value for this Port.", "example": "kbps" } ] }, "actualRate": { "description": "The rate of this Port, in units specified by the 'actualRateUnits' field value.", "example": 100000, "type": "number" }, "portMode": { "type": "object", "allOf": [ { "title": "PortMode", "description": "The mode of port.", "example": "access", "type": "string", "enum": [ "undefined", "access", "trunk", "hybrid" ] }, { "description": "The mode of port.", "example": "access" } ] }, "encapType": { "type": "object", "allOf": [ { "title": "EncapType1", "description": "The Encapsulation type of the port", "example": "dot1q", "type": "string", "enum": [ "unknown", "other", "nullEncap", "dot1q", "qinq", "mpls", "bcpNull", "bcpDot1q", "ipcp", "frameRelay", "pppAuto", "atm", "wanMirror", "ciscoHdlc", "cem", "rhdlc", "raw", "cellular", "wlan" ] }, { "description": "The Encapsulation type of the port", "example": "dot1q" } ] }, "mtuValue": { "description": "The MTU value of the port in bytes.", "example": 1578, "type": "integer" } }, "required": [ "portMode" ] }, "lagDetails": { "title": "LAGMemberDetails", "type": "object", "properties": { "encapType": { "type": "string" }, "fdn": { "type": "string" }, "lagId": { "type": "string" }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "portFdn": { "type": "string" }, "portName": { "type": "string" }, "priority": { "type": "integer" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" } } } }, "required": [ "fdn", "sourceType", "sourceSystem", "sources", "name", "neName", "neId", "positionId", "position", "adminState", "operState", "standbyState", "availabilityStates" ] } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCardPortsUsingGET" }, "task": true }, { "name": "getShelfPortsUsingGET", "summary": "getShelfPortsUsingGET", "description": "Returns a list of specific ports. The list will contain the FDN of each resulting port. Not providing a filter will return all ports. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The user friendly visible name neName: The name of the Network Element containing this Port neId: The id of the Network Element containing this Port description: T...(description truncated)", "input": [ { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "networkElementFdn", "type": "string", "info": "networkElementFdn: string", "required": true, "schema": { "title": "networkElementFdn", "type": "string" } }, { "name": "shelfFdn", "type": "string", "info": "shelfFdn: string", "required": true, "schema": { "title": "shelfFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "Port", "type": "object", "properties": { "links": { "xml": { "namespace": "http://www.w3.org/2005/Atom", "attribute": false, "wrapped": false }, "type": "array", "items": { "title": "Link", "type": "object", "properties": { "href": { "xml": { "name": "href", "attribute": true, "wrapped": false }, "type": "string" }, "rel": { "xml": { "name": "rel", "attribute": true, "wrapped": false }, "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "description": "The Fully Distinguished Name of this Port.", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType5", "description": "The type of the source system where this Port is sourced from.", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "description": "The type of the source system where this Port is sourced from." } ] }, "sourceSystem": { "description": "The source system where this Port is sourced from.", "type": "string" }, "sources": { "description": "The Fully Distinguished Names of the Ports from the source system associated to this Port.", "type": "array", "items": { "type": "string" } }, "name": { "description": "The name of this Port, as defined by the source system.", "type": "string" }, "neName": { "description": "The name of the Network Element containing this Port, as defined by the source system.", "type": "string" }, "neId": { "description": "The id of the Network Element containing this Port, as defined by the source system.", "type": "string" }, "description": { "description": "The detailed description of this Port.", "type": "string" }, "positionId": { "description": "The relative position of the Port, that determines the order in which to show it in the source system UI.", "type": "integer" }, "position": { "description": "A formatted name that describes the position of the Port within the Network Element.", "type": "string" }, "adminState": { "type": "object", "allOf": [ { "title": "AdminState5", "description": "The administrative state of this Port. Refer to the X.731 standard.", "example": "unlocked", "type": "string", "enum": [ "unknown", "unlocked", "locked", "forcedLockout", "shuttingDown", "maintenance" ] }, { "description": "The administrative state of this Port. Refer to the X.731 standard." } ] }, "operState": { "type": "object", "allOf": [ { "title": "OperState5", "description": "The operational state of this Port. Refer to the X.731 standard.", "example": "enabled", "type": "string", "enum": [ "unknown", "enabled", "disabled" ] }, { "description": "The operational state of this Port. Refer to the X.731 standard." } ] }, "standbyState": { "type": "object", "allOf": [ { "title": "StandbyState5", "description": "The standby state of this Port. Refer to the X.731 standard.", "example": "providingService", "type": "string", "enum": [ "providingService", "standby" ] }, { "description": "The standby state of this Port. Refer to the X.731 standard." } ] }, "availabilityStates": { "description": "The availability states of this Port. Refer to the X.731 standard.", "type": "array", "items": { "title": "AvailabilityState", "type": "string", "enum": [ "unknown", "inTest", "failed", "degraded", "offLine", "powerOff", "offDuty", "dependency", "notInstalled", "logFull" ] } }, "stateReasons": { "description": "A set of specific reasons why the Port is in this state.", "type": "array", "items": { "type": "string" } }, "objectDetails": { "description": "Generic properties of this Port, specific to the Network Supervision application.", "type": "object", "additionalProperties": { "type": "string" } }, "manufacturer": { "description": "The vendor of the Port.", "type": "string" }, "serialNumber": { "description": "The serial number of the Port provided by the manufacturer.", "type": "string" }, "partNumber": { "description": "The part number of the Port provided by the manufacturer.", "type": "string" }, "manufacturerAssemblyNumber": { "description": "The assembly number of the Port provided by the manufacturer.", "type": "string" }, "manufactureDate": { "description": "The date of manufacture of the Port.", "type": "string" }, "manufacturingDeviations": { "description": "The manufacturing deviations of the Port provided by the manufacturer.", "type": "string" }, "macAddress": { "description": "The Configured MAC Address of the Port", "type": "string" }, "hwMacAddress": { "description": "The Hardware MAC Address of the Port", "type": "string" }, "portDetails": { "title": "PortDetails", "type": "object", "properties": { "fdn": { "example": "fdn:model:equipment:PortDetails:2209", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType1", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "example": "nfmp" } ] }, "sourceSystem": { "example": "fdn:realm:sam", "type": "string" }, "sources": { "example": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card:port-1@portDetails" ], "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "portIndex": { "description": "The index of this Port. Generally, this is the SNMP 'ifIndex', if available.", "example": 67141632, "type": "integer" }, "portType": { "type": "object", "allOf": [ { "title": "PortType", "description": "The type of this Port.", "example": "ethernet", "type": "string", "enum": [ "ext", "unknown", "none", "other", "ethernet", "sonet", "virtual", "sonetChannel", "tdm", "radio", "wireless", "serial", "voice", "wdm", "gpon", "dsl", "otu", "sdh", "connector", "coherentOptical", "otClient", "otLine" ] }, { "description": "The type of this Port.", "example": "ethernet" } ] }, "rate": { "description": "The rate label of this Port.", "example": "ethernet100", "type": "string" }, "actualRateUnits": { "type": "object", "allOf": [ { "title": "ActualRateUnits1", "description": "The units associated to the 'actualRate' field value for this Port.", "example": "kbps", "type": "string", "enum": [ "unknown", "kbps", "Mbps" ] }, { "description": "The units associated to the 'actualRate' field value for this Port.", "example": "kbps" } ] }, "actualRate": { "description": "The rate of this Port, in units specified by the 'actualRateUnits' field value.", "example": 100000, "type": "number" }, "portMode": { "type": "object", "allOf": [ { "title": "PortMode", "description": "The mode of port.", "example": "access", "type": "string", "enum": [ "undefined", "access", "trunk", "hybrid" ] }, { "description": "The mode of port.", "example": "access" } ] }, "encapType": { "type": "object", "allOf": [ { "title": "EncapType1", "description": "The Encapsulation type of the port", "example": "dot1q", "type": "string", "enum": [ "unknown", "other", "nullEncap", "dot1q", "qinq", "mpls", "bcpNull", "bcpDot1q", "ipcp", "frameRelay", "pppAuto", "atm", "wanMirror", "ciscoHdlc", "cem", "rhdlc", "raw", "cellular", "wlan" ] }, { "description": "The Encapsulation type of the port", "example": "dot1q" } ] }, "mtuValue": { "description": "The MTU value of the port in bytes.", "example": 1578, "type": "integer" } }, "required": [ "portMode" ] }, "lagDetails": { "title": "LAGMemberDetails", "type": "object", "properties": { "encapType": { "type": "string" }, "fdn": { "type": "string" }, "lagId": { "type": "string" }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "portFdn": { "type": "string" }, "portName": { "type": "string" }, "priority": { "type": "integer" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" } } } }, "required": [ "fdn", "sourceType", "sourceSystem", "sources", "name", "neName", "neId", "positionId", "position", "adminState", "operState", "standbyState", "availabilityStates" ] } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getShelfPortsUsingGET" }, "task": true }, { "name": "getPhysicalLinksUsingGET", "summary": "getPhysicalLinksUsingGET", "description": "Returns a paged list of specific physical links. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting physical link. Not providing a filter will return all physical links. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The user friendly visible name id: The short identifier of the Physi...(description truncated)", "input": [ { "name": "fdns", "type": "string", "info": "A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.: string", "required": false, "schema": { "title": "fdns", "type": "string" } }, { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "limit", "type": "number", "info": "The limit on the number of objects returned (max: 1000): 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "neFetch", "type": "boolean", "info": "A boolean value to determine whether to fetch NE data: boolean", "required": false, "schema": { "title": "neFetch", "type": "boolean" } }, { "name": "offset", "type": "number", "info": "Start row for paged data (max: total number of objects): 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "PhysicalLink", "type": "object", "properties": { "links": { "xml": { "namespace": "http://www.w3.org/2005/Atom", "attribute": false, "wrapped": false }, "type": "array", "items": { "title": "Link", "type": "object", "properties": { "href": { "xml": { "name": "href", "attribute": true, "wrapped": false }, "type": "string" }, "rel": { "xml": { "name": "rel", "attribute": true, "wrapped": false }, "type": "string" }, "templated": { "type": "boolean" } } } }, "sourceType": { "description": "The type of the source system where this Service is sourced from. Read only.", "type": "string" }, "fdn": { "description": "The Fully Distinguished Name of the Physical Link. Read only.", "type": "string" }, "sourceSystem": { "description": "The source system where this Service is sourced from. Read only.", "type": "string" }, "sources": { "description": "The Fully Distinguished Names of the Physical Links from the source system associated to this Physical Link. Read only.", "type": "array", "items": { "type": "string" } }, "name": { "description": "The user-friendly name of this Physical Link. Mandatory property for creation.", "type": "string" }, "id": { "description": "The short identifier of this Physical Link. Mandatory property for creation.", "type": "string" }, "type": { "description": "The type of this Physical Link. Mandatory property for creation.", "type": "string", "default": "cable" }, "rate": { "description": "The rate label of this Physical Link. Defaults to null value.", "type": "string" }, "actualRate": { "description": "The rate of this Physical Link, in units specified by the 'actualRateUnits' field value. Defaults to null value.", "type": "number" }, "actualRateUnits": { "type": "object", "allOf": [ { "title": "ActualRateUnits", "description": "The units associated to the 'actualRate' field value for this Physical Link. Default to 'unknown'.", "example": "kbps", "type": "string", "enum": [ "unknown", "kbps", "Mbps" ] }, { "description": "The units associated to the 'actualRate' field value for this Physical Link. Default to 'unknown'." } ] }, "description": { "description": "The detailed description of this Physical Link.", "type": "string" }, "protection": { "type": "object", "allOf": [ { "title": "Protection", "description": "Indicates if this Physical Link is protected or unprotected. Defaults to 'unknown'.", "example": "Protected", "type": "string", "enum": [ "unknown", "Unprotected", "Protected" ] }, { "description": "Indicates if this Physical Link is protected or unprotected. Defaults to 'unknown'." } ] }, "protectionKind": { "type": "object", "allOf": [ { "title": "ProtectionKind", "description": "The type of protection for this Physical Link. Defaults to 'unknown'.", "example": "unknown", "type": "string", "enum": [ "unknown", "oneToOne", "oneToMany", "opsaProtected", "opsbProtected", "yCableProtected", "esncpSncI", "esncpSncN", "esncpSncS", "omsp", "olp" ] }, { "description": "The type of protection for this Physical Link. Defaults to 'unknown'." } ] }, "latency": { "description": "The latency of this Physical Link, if known, in units specified by the 'latencyUnits' field value. Defaults to 0.", "type": "integer" }, "latencyUnits": { "type": "object", "allOf": [ { "title": "LatencyUnits", "description": "The units associated to the 'latency' field value for this Physical Link. Default to 'unknown'.", "example": "nanoseconds", "type": "string", "enum": [ "unknown", "nanoseconds", "microseconds", "milliseconds", "seconds", "minutes", "hours", "days" ] }, { "description": "The units associated to the 'latency' field value for this Physical Link. Default to 'unknown'." } ] }, "restoration": { "type": "object", "allOf": [ { "title": "Restoration", "description": "The restoration type for this Physical Link. Defaults to 'unknown'.", "example": "unknown", "type": "string", "enum": [ "unknown", "none", "sourceBased", "guaranteed" ] }, { "description": "The restoration type for this Physical Link. Defaults to 'unknown'." } ] }, "direction": { "type": "object", "allOf": [ { "title": "Direction", "description": "The direction of this Physical Link. Defaults to 'unknown'.", "example": "uniDirectional", "type": "string", "enum": [ "unknown", "uniDirectional", "biDirectional" ] }, { "description": "The direction of this Physical Link. Defaults to 'unknown'." } ] }, "adminState": { "type": "object", "allOf": [ { "title": "AdminState4", "description": "The adminstrative state of this Physical Link. Defaults to 'unknown'. Refer to the X.731 standard.", "example": "unknown", "type": "string", "enum": [ "unknown", "unlocked", "locked", "forcedLockout", "shuttingDown", "maintenance" ] }, { "description": "The adminstrative state of this Physical Link. Defaults to 'unknown'. Refer to the X.731 standard." } ] }, "operState": { "type": "object", "allOf": [ { "title": "OperState4", "description": "The operational state of this Physical Link. Read only. Defaults to 'unknown'. Refer to the X.731 standard.", "type": "string", "enum": [ "unknown", "enabled", "disabled" ] }, { "description": "The operational state of this Physical Link. Read only. Defaults to 'unknown'. Refer to the X.731 standard." } ] }, "standbyState": { "type": "object", "allOf": [ { "title": "StandbyState4", "description": "The standby state of this Physical Link. Defaults to 'providingService'. Refer to the X.731 standard.", "example": "providingService", "type": "string", "enum": [ "providingService", "standby" ] }, { "description": "The standby state of this Physical Link. Defaults to 'providingService'. Refer to the X.731 standard." } ] }, "availabilityStates": { "description": "The availability states of this Physical Link. Defaults to 'unknown', if present. Refer to the X.731 standard", "type": "array", "items": { "title": "AvailabilityState", "type": "string", "enum": [ "unknown", "inTest", "failed", "degraded", "offLine", "powerOff", "offDuty", "dependency", "notInstalled", "logFull" ] } }, "objectDetails": { "description": "Generic properties of this Physical Link, specific to the Network Supervision application.", "type": "object", "additionalProperties": { "type": "string" } }, "endpoints": { "description": "The Endpoints associated to this Physical Link. Mandatory property for creation.", "type": "array", "items": { "title": "PhysicalLinkEndpoint", "type": "object", "properties": { "name": { "description": "The name of this Physical Link Endpoint. Defaults to null value.", "example": "Port 1/1/1", "type": "string" }, "type": { "type": "object", "allOf": [ { "title": "Type", "description": "The type of this Physical Link Endpoint. Mandatory property for creation.", "example": "physicalPort", "type": "string", "enum": [ "physicalPort", "networkElement", "lag" ] }, { "description": "The type of this Physical Link Endpoint. Mandatory property for creation.", "example": "physicalPort" } ] }, "port": { "description": "The Fully Distinguished Name of the Port to use. Mandatory property for creation, if and only if 'type' value is 'physicalPort'.", "example": "fdn:model:equipment:Equipment:2189", "type": "string" }, "lag": { "description": "The Fully Distinguished Name of the LAG to use. Mandatory property for creation, if and only if 'type' value is 'lag'.", "example": "null", "type": "string" }, "parentNe": { "description": "The Fully Distinguished Name of the Network Element containing this Physical Link Endpoint. Mandatory property for creation.", "example": "fdn:model:equipment:NetworkElement:2102", "type": "string" }, "parentNeId": { "description": "The identifier of the Network Element containing this Physical Link Endpoint. Mandatory property for creation.", "example": "38.120.169.111", "type": "string" }, "subnetName": { "description": "Will always be null, for the 'physicalPort', 'networkElement' and 'lag' types. Defaults to null value.", "example": "null", "type": "string" }, "objectDetails": { "description": "Generic properties of this Physical Link Endpoint, specific to the Network Supervision application.", "type": "object", "additionalProperties": { "type": "string" } }, "parentNeName": { "description": "The name of the Network Element containing this Physical Link Endpoint", "type": "string" } }, "required": [ "type", "port", "lag", "parentNe", "parentNeId" ] } } }, "required": [ "name", "id", "type", "endpoints" ] } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPhysicalLinksUsingGET" }, "task": true }, { "name": "createPhysicalLinkUsingPOST", "summary": "createPhysicalLinkUsingPOST", "description": "This API allows admin users to create a 'cable' physical link manually. Endpoints can either be physicalPort to physicalPort or networkElement to networkElement or LAG to LAG.", "input": [ { "name": "physicalLink", "type": "object", "info": "physicalLink: {\"links\": [{\"href\": \"string\", \"rel\": \"string\", \"templated\": \"boolean\"}], \"sourceType\": \"string\", \"fdn\": \"string\", \"sourceSystem\": \"string\", \"sources\": \"array\", \"name\": \"string\", \"id\": \"string\", \"type\": \"string\", \"rate\": \"string\", \"actualRate\": 123, \"actualRateUnits\": \"object\", \"description\": \"string\", \"protection\": \"object\", \"protectionKind\": \"object\", \"latency\": 123, \"latencyUnits\": \"object\", \"restoration\": \"object\", \"direction\": \"object\", \"adminState\": \"object\", \"operState\": \"object\", \"standbyState\": \"object\", \"availabilityStates\": \"array\", \"objectDetails\": \"object\", \"endpoints\": [{\"name\": \"string\", \"type\": \"object\", \"port\": \"string\", \"lag\": \"string\", \"parentNe\": \"string\", \"parentNeId\": \"string\", \"subnetName\": \"string\", \"objectDetails\": \"object\", \"parentNeName\": \"string\"}]}", "required": true, "schema": { "title": "PhysicalLink", "type": "object", "properties": { "links": { "xml": { "namespace": "http://www.w3.org/2005/Atom", "attribute": false, "wrapped": false }, "type": "array", "items": { "title": "Link", "type": "object", "properties": { "href": { "xml": { "name": "href", "attribute": true, "wrapped": false }, "type": "string" }, "rel": { "xml": { "name": "rel", "attribute": true, "wrapped": false }, "type": "string" }, "templated": { "type": "boolean" } } } }, "sourceType": { "description": "The type of the source system where this Service is sourced from. Read only.", "type": "string" }, "fdn": { "description": "The Fully Distinguished Name of the Physical Link. Read only.", "type": "string" }, "sourceSystem": { "description": "The source system where this Service is sourced from. Read only.", "type": "string" }, "sources": { "description": "The Fully Distinguished Names of the Physical Links from the source system associated to this Physical Link. Read only.", "type": "array", "items": { "type": "string" } }, "name": { "description": "The user-friendly name of this Physical Link. Mandatory property for creation.", "type": "string" }, "id": { "description": "The short identifier of this Physical Link. Mandatory property for creation.", "type": "string" }, "type": { "description": "The type of this Physical Link. Mandatory property for creation.", "type": "string", "default": "cable" }, "rate": { "description": "The rate label of this Physical Link. Defaults to null value.", "type": "string" }, "actualRate": { "description": "The rate of this Physical Link, in units specified by the 'actualRateUnits' field value. Defaults to null value.", "type": "number" }, "actualRateUnits": { "type": "object", "allOf": [ { "title": "ActualRateUnits", "description": "The units associated to the 'actualRate' field value for this Physical Link. Default to 'unknown'.", "example": "kbps", "type": "string", "enum": [ "unknown", "kbps", "Mbps" ] }, { "description": "The units associated to the 'actualRate' field value for this Physical Link. Default to 'unknown'." } ] }, "description": { "description": "The detailed description of this Physical Link.", "type": "string" }, "protection": { "type": "object", "allOf": [ { "title": "Protection", "description": "Indicates if this Physical Link is protected or unprotected. Defaults to 'unknown'.", "example": "Protected", "type": "string", "enum": [ "unknown", "Unprotected", "Protected" ] }, { "description": "Indicates if this Physical Link is protected or unprotected. Defaults to 'unknown'." } ] }, "protectionKind": { "type": "object", "allOf": [ { "title": "ProtectionKind", "description": "The type of protection for this Physical Link. Defaults to 'unknown'.", "example": "unknown", "type": "string", "enum": [ "unknown", "oneToOne", "oneToMany", "opsaProtected", "opsbProtected", "yCableProtected", "esncpSncI", "esncpSncN", "esncpSncS", "omsp", "olp" ] }, { "description": "The type of protection for this Physical Link. Defaults to 'unknown'." } ] }, "latency": { "description": "The latency of this Physical Link, if known, in units specified by the 'latencyUnits' field value. Defaults to 0.", "type": "integer" }, "latencyUnits": { "type": "object", "allOf": [ { "title": "LatencyUnits", "description": "The units associated to the 'latency' field value for this Physical Link. Default to 'unknown'.", "example": "nanoseconds", "type": "string", "enum": [ "unknown", "nanoseconds", "microseconds", "milliseconds", "seconds", "minutes", "hours", "days" ] }, { "description": "The units associated to the 'latency' field value for this Physical Link. Default to 'unknown'." } ] }, "restoration": { "type": "object", "allOf": [ { "title": "Restoration", "description": "The restoration type for this Physical Link. Defaults to 'unknown'.", "example": "unknown", "type": "string", "enum": [ "unknown", "none", "sourceBased", "guaranteed" ] }, { "description": "The restoration type for this Physical Link. Defaults to 'unknown'." } ] }, "direction": { "type": "object", "allOf": [ { "title": "Direction", "description": "The direction of this Physical Link. Defaults to 'unknown'.", "example": "uniDirectional", "type": "string", "enum": [ "unknown", "uniDirectional", "biDirectional" ] }, { "description": "The direction of this Physical Link. Defaults to 'unknown'." } ] }, "adminState": { "type": "object", "allOf": [ { "title": "AdminState4", "description": "The adminstrative state of this Physical Link. Defaults to 'unknown'. Refer to the X.731 standard.", "example": "unknown", "type": "string", "enum": [ "unknown", "unlocked", "locked", "forcedLockout", "shuttingDown", "maintenance" ] }, { "description": "The adminstrative state of this Physical Link. Defaults to 'unknown'. Refer to the X.731 standard." } ] }, "operState": { "type": "object", "allOf": [ { "title": "OperState4", "description": "The operational state of this Physical Link. Read only. Defaults to 'unknown'. Refer to the X.731 standard.", "type": "string", "enum": [ "unknown", "enabled", "disabled" ] }, { "description": "The operational state of this Physical Link. Read only. Defaults to 'unknown'. Refer to the X.731 standard." } ] }, "standbyState": { "type": "object", "allOf": [ { "title": "StandbyState4", "description": "The standby state of this Physical Link. Defaults to 'providingService'. Refer to the X.731 standard.", "example": "providingService", "type": "string", "enum": [ "providingService", "standby" ] }, { "description": "The standby state of this Physical Link. Defaults to 'providingService'. Refer to the X.731 standard." } ] }, "availabilityStates": { "description": "The availability states of this Physical Link. Defaults to 'unknown', if present. Refer to the X.731 standard", "type": "array", "items": { "title": "AvailabilityState", "type": "string", "enum": [ "unknown", "inTest", "failed", "degraded", "offLine", "powerOff", "offDuty", "dependency", "notInstalled", "logFull" ] } }, "objectDetails": { "description": "Generic properties of this Physical Link, specific to the Network Supervision application.", "type": "object", "additionalProperties": { "type": "string" } }, "endpoints": { "description": "The Endpoints associated to this Physical Link. Mandatory property for creation.", "type": "array", "items": { "title": "PhysicalLinkEndpoint", "type": "object", "properties": { "name": { "description": "The name of this Physical Link Endpoint. Defaults to null value.", "example": "Port 1/1/1", "type": "string" }, "type": { "type": "object", "allOf": [ { "title": "Type", "description": "The type of this Physical Link Endpoint. Mandatory property for creation.", "example": "physicalPort", "type": "string", "enum": [ "physicalPort", "networkElement", "lag" ] }, { "description": "The type of this Physical Link Endpoint. Mandatory property for creation.", "example": "physicalPort" } ] }, "port": { "description": "The Fully Distinguished Name of the Port to use. Mandatory property for creation, if and only if 'type' value is 'physicalPort'.", "example": "fdn:model:equipment:Equipment:2189", "type": "string" }, "lag": { "description": "The Fully Distinguished Name of the LAG to use. Mandatory property for creation, if and only if 'type' value is 'lag'.", "example": "null", "type": "string" }, "parentNe": { "description": "The Fully Distinguished Name of the Network Element containing this Physical Link Endpoint. Mandatory property for creation.", "example": "fdn:model:equipment:NetworkElement:2102", "type": "string" }, "parentNeId": { "description": "The identifier of the Network Element containing this Physical Link Endpoint. Mandatory property for creation.", "example": "38.120.169.111", "type": "string" }, "subnetName": { "description": "Will always be null, for the 'physicalPort', 'networkElement' and 'lag' types. Defaults to null value.", "example": "null", "type": "string" }, "objectDetails": { "description": "Generic properties of this Physical Link Endpoint, specific to the Network Supervision application.", "type": "object", "additionalProperties": { "type": "string" } }, "parentNeName": { "description": "The name of the Network Element containing this Physical Link Endpoint", "type": "string" } }, "required": [ "type", "port", "lag", "parentNe", "parentNeId" ] } } }, "required": [ "name", "id", "type", "endpoints" ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createPhysicalLinkUsingPOST" }, "task": true }, { "name": "getPhysicalLinkUsingGET", "summary": "getPhysicalLinkUsingGET", "description": "Returns detailed information for the specified physical link. Example: GET /v1/physicalLinks/fdn:model:service:Service:2410", "input": [ { "name": "physicalLinkFdn", "type": "string", "info": "physicalLinkFdn: string", "required": true, "schema": { "title": "physicalLinkFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPhysicalLinkUsingGET" }, "task": true }, { "name": "deletePhysicalLinkUsingDELETE", "summary": "deletePhysicalLinkUsingDELETE", "description": "This API allows admin users to delete a manually created physical link.", "input": [ { "name": "physicalLinkFdn", "type": "string", "info": "physicalLinkFdn: string", "required": true, "schema": { "title": "physicalLinkFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deletePhysicalLinkUsingDELETE" }, "task": true }, { "name": "getPortsUsingGET", "summary": "getPortsUsingGET", "description": "Returns a paged list of specific ports. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting port. Not providing a filter will return all ports. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The user friendly visible name neName: The name of the Network Element containing this Port n...(description truncated)", "input": [ { "name": "fdns", "type": "string", "info": "A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.: string", "required": false, "schema": { "title": "fdns", "type": "string" } }, { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "limit", "type": "number", "info": "The limit on the number of objects returned (max: 1000): 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "Start row for paged data (max: total number of objects): 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "Port", "type": "object", "properties": { "links": { "xml": { "namespace": "http://www.w3.org/2005/Atom", "attribute": false, "wrapped": false }, "type": "array", "items": { "title": "Link", "type": "object", "properties": { "href": { "xml": { "name": "href", "attribute": true, "wrapped": false }, "type": "string" }, "rel": { "xml": { "name": "rel", "attribute": true, "wrapped": false }, "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "description": "The Fully Distinguished Name of this Port.", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType5", "description": "The type of the source system where this Port is sourced from.", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "description": "The type of the source system where this Port is sourced from." } ] }, "sourceSystem": { "description": "The source system where this Port is sourced from.", "type": "string" }, "sources": { "description": "The Fully Distinguished Names of the Ports from the source system associated to this Port.", "type": "array", "items": { "type": "string" } }, "name": { "description": "The name of this Port, as defined by the source system.", "type": "string" }, "neName": { "description": "The name of the Network Element containing this Port, as defined by the source system.", "type": "string" }, "neId": { "description": "The id of the Network Element containing this Port, as defined by the source system.", "type": "string" }, "description": { "description": "The detailed description of this Port.", "type": "string" }, "positionId": { "description": "The relative position of the Port, that determines the order in which to show it in the source system UI.", "type": "integer" }, "position": { "description": "A formatted name that describes the position of the Port within the Network Element.", "type": "string" }, "adminState": { "type": "object", "allOf": [ { "title": "AdminState5", "description": "The administrative state of this Port. Refer to the X.731 standard.", "example": "unlocked", "type": "string", "enum": [ "unknown", "unlocked", "locked", "forcedLockout", "shuttingDown", "maintenance" ] }, { "description": "The administrative state of this Port. Refer to the X.731 standard." } ] }, "operState": { "type": "object", "allOf": [ { "title": "OperState5", "description": "The operational state of this Port. Refer to the X.731 standard.", "example": "enabled", "type": "string", "enum": [ "unknown", "enabled", "disabled" ] }, { "description": "The operational state of this Port. Refer to the X.731 standard." } ] }, "standbyState": { "type": "object", "allOf": [ { "title": "StandbyState5", "description": "The standby state of this Port. Refer to the X.731 standard.", "example": "providingService", "type": "string", "enum": [ "providingService", "standby" ] }, { "description": "The standby state of this Port. Refer to the X.731 standard." } ] }, "availabilityStates": { "description": "The availability states of this Port. Refer to the X.731 standard.", "type": "array", "items": { "title": "AvailabilityState", "type": "string", "enum": [ "unknown", "inTest", "failed", "degraded", "offLine", "powerOff", "offDuty", "dependency", "notInstalled", "logFull" ] } }, "stateReasons": { "description": "A set of specific reasons why the Port is in this state.", "type": "array", "items": { "type": "string" } }, "objectDetails": { "description": "Generic properties of this Port, specific to the Network Supervision application.", "type": "object", "additionalProperties": { "type": "string" } }, "manufacturer": { "description": "The vendor of the Port.", "type": "string" }, "serialNumber": { "description": "The serial number of the Port provided by the manufacturer.", "type": "string" }, "partNumber": { "description": "The part number of the Port provided by the manufacturer.", "type": "string" }, "manufacturerAssemblyNumber": { "description": "The assembly number of the Port provided by the manufacturer.", "type": "string" }, "manufactureDate": { "description": "The date of manufacture of the Port.", "type": "string" }, "manufacturingDeviations": { "description": "The manufacturing deviations of the Port provided by the manufacturer.", "type": "string" }, "macAddress": { "description": "The Configured MAC Address of the Port", "type": "string" }, "hwMacAddress": { "description": "The Hardware MAC Address of the Port", "type": "string" }, "portDetails": { "title": "PortDetails", "type": "object", "properties": { "fdn": { "example": "fdn:model:equipment:PortDetails:2209", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType1", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "example": "nfmp" } ] }, "sourceSystem": { "example": "fdn:realm:sam", "type": "string" }, "sources": { "example": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card:port-1@portDetails" ], "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "portIndex": { "description": "The index of this Port. Generally, this is the SNMP 'ifIndex', if available.", "example": 67141632, "type": "integer" }, "portType": { "type": "object", "allOf": [ { "title": "PortType", "description": "The type of this Port.", "example": "ethernet", "type": "string", "enum": [ "ext", "unknown", "none", "other", "ethernet", "sonet", "virtual", "sonetChannel", "tdm", "radio", "wireless", "serial", "voice", "wdm", "gpon", "dsl", "otu", "sdh", "connector", "coherentOptical", "otClient", "otLine" ] }, { "description": "The type of this Port.", "example": "ethernet" } ] }, "rate": { "description": "The rate label of this Port.", "example": "ethernet100", "type": "string" }, "actualRateUnits": { "type": "object", "allOf": [ { "title": "ActualRateUnits1", "description": "The units associated to the 'actualRate' field value for this Port.", "example": "kbps", "type": "string", "enum": [ "unknown", "kbps", "Mbps" ] }, { "description": "The units associated to the 'actualRate' field value for this Port.", "example": "kbps" } ] }, "actualRate": { "description": "The rate of this Port, in units specified by the 'actualRateUnits' field value.", "example": 100000, "type": "number" }, "portMode": { "type": "object", "allOf": [ { "title": "PortMode", "description": "The mode of port.", "example": "access", "type": "string", "enum": [ "undefined", "access", "trunk", "hybrid" ] }, { "description": "The mode of port.", "example": "access" } ] }, "encapType": { "type": "object", "allOf": [ { "title": "EncapType1", "description": "The Encapsulation type of the port", "example": "dot1q", "type": "string", "enum": [ "unknown", "other", "nullEncap", "dot1q", "qinq", "mpls", "bcpNull", "bcpDot1q", "ipcp", "frameRelay", "pppAuto", "atm", "wanMirror", "ciscoHdlc", "cem", "rhdlc", "raw", "cellular", "wlan" ] }, { "description": "The Encapsulation type of the port", "example": "dot1q" } ] }, "mtuValue": { "description": "The MTU value of the port in bytes.", "example": 1578, "type": "integer" } }, "required": [ "portMode" ] }, "lagDetails": { "title": "LAGMemberDetails", "type": "object", "properties": { "encapType": { "type": "string" }, "fdn": { "type": "string" }, "lagId": { "type": "string" }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "portFdn": { "type": "string" }, "portName": { "type": "string" }, "priority": { "type": "integer" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" } } } }, "required": [ "fdn", "sourceType", "sourceSystem", "sources", "name", "neName", "neId", "positionId", "position", "adminState", "operState", "standbyState", "availabilityStates" ] } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPortsUsingGET" }, "task": true }, { "name": "getPortUsingGET", "summary": "getPortUsingGET", "description": "Returns detailed information for the specified port. Example: GET /v1/ports/equipment:Equipment:2189", "input": [ { "name": "portFdn", "type": "string", "info": "portFdn: string", "required": true, "schema": { "title": "portFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPortUsingGET" }, "task": true }, { "name": "getRadioEquipmentsUsingGET", "summary": "getRadioEquipmentsUsingGET", "description": "Returns a paged list of specific radio equipments. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting Radio Equipment. Not providing a filter will return all Radio Equipments. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The name of the radio equipment, as defined by the source system ...(description truncated)", "input": [ { "name": "fdns", "type": "string", "info": "A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.: string", "required": false, "schema": { "title": "fdns", "type": "string" } }, { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "limit", "type": "number", "info": "The limit on the number of objects returned (max: 1000): 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "Start row for paged data (max: total number of objects): 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "RadioEquipment", "type": "object", "properties": { "adminState": { "type": "string" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "chassisType": { "type": "string" }, "clliCode": { "type": "string" }, "communicationState": { "type": "string" }, "description": { "type": "string" }, "fdn": { "type": "string" }, "ipAddress": { "type": "string" }, "latitude": { "type": "number" }, "links": { "xml": { "namespace": "http://www.w3.org/2005/Atom", "attribute": false, "wrapped": false }, "type": "array", "items": { "title": "Link", "type": "object", "properties": { "href": { "xml": { "name": "href", "attribute": true, "wrapped": false }, "type": "string" }, "rel": { "xml": { "name": "rel", "attribute": true, "wrapped": false }, "type": "string" }, "templated": { "type": "boolean" } } } }, "location": { "type": "string" }, "longitude": { "type": "number" }, "macAddress": { "type": "string" }, "managedState": { "type": "string" }, "name": { "type": "string" }, "neId": { "type": "string" }, "neName": { "type": "string" }, "objectDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "operState": { "type": "string" }, "parentNeName": { "type": "string" }, "product": { "type": "string" }, "resyncState": { "type": "string" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" }, "systemAddress": { "type": "string" }, "version": { "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRadioEquipmentsUsingGET" }, "task": true }, { "name": "getRadioEquipmentUsingGET", "summary": "getRadioEquipmentUsingGET", "description": "Returns detailed information for the specified radio equipment. Example:", "input": [ { "name": "radioEquipmentFdn", "type": "string", "info": "radioEquipmentFdn: string", "required": true, "schema": { "title": "radioEquipmentFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRadioEquipmentUsingGET" }, "task": true }, { "name": "getShelvesUsingGET", "summary": "getShelvesUsingGET", "description": "Returns a paged list of specific shelves. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting shelf. Not providing a filter will return all shelves. Filterable properties: sourceType: The type of the source system. For example: nfmp sourceSystem: The partial FDN identifying the source system. For example: fdn:realm:sam name: The user friendly visible name neName: The name of the Network Element containing the Shel...(description truncated)", "input": [ { "name": "fdns", "type": "string", "info": "A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.: string", "required": false, "schema": { "title": "fdns", "type": "string" } }, { "name": "filter", "type": "string", "info": "The criteria to use for filtering. Filter parameter supports NBI standard query language.\n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (descripti...(description truncated): string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "limit", "type": "number", "info": "The limit on the number of objects returned (max: 1000): 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "Start row for paged data (max: total number of objects): 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "default": "", "items": { "title": "Shelf", "type": "object", "properties": { "links": { "xml": { "namespace": "http://www.w3.org/2005/Atom", "attribute": false, "wrapped": false }, "type": "array", "items": { "title": "Link", "type": "object", "properties": { "href": { "xml": { "name": "href", "attribute": true, "wrapped": false }, "type": "string" }, "rel": { "xml": { "name": "rel", "attribute": true, "wrapped": false }, "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "description": "The Fully Distinguished Name of this Shelf.", "type": "string" }, "sourceType": { "type": "object", "allOf": [ { "title": "SourceType7", "description": "The type of the source system where this Shelf is sourced from.", "example": "nfmp", "type": "string", "enum": [ "other", "nsd", "nfmp", "nfmt", "nrcp", "nrct", "nrcf", "nrcx", "mdm", "nsp" ] }, { "description": "The type of the source system where this Shelf is sourced from." } ] }, "sourceSystem": { "description": "The source system where this Shelf is sourced from.", "type": "string" }, "sources": { "description": "The Fully Distinguished Names of the Shelves from the source system associated to this Shelf.", "type": "array", "items": { "type": "string" } }, "name": { "description": "The name of this Shelf, as defined by the source system.", "type": "string" }, "neName": { "description": "The name of the Network Element containing this Shelf, as defined by the source system.", "type": "string" }, "neId": { "description": "The id of the Network Element containing this Shelf, as defined by the source system.", "type": "string" }, "description": { "description": "The detailed description of this Shelf.", "type": "string" }, "positionId": { "description": "The relative position of the Shelf, that determines the order in which to show it in the source system UI.", "type": "integer" }, "position": { "description": "A formatted name that describes the position of the Shelf within the Network Element.", "type": "string" }, "adminState": { "type": "object", "allOf": [ { "title": "AdminState6", "description": "The administrative state of this Shelf. Refer to the X.731 standard.", "example": "unlocked", "type": "string", "enum": [ "unknown", "unlocked", "locked", "forcedLockout", "shuttingDown", "maintenance" ] }, { "description": "The administrative state of this Shelf. Refer to the X.731 standard." } ] }, "operState": { "type": "object", "allOf": [ { "title": "OperState6", "description": "The operational state of this Shelf. Refer to the X.731 standard.", "example": "enabled", "type": "string", "enum": [ "unknown", "enabled", "disabled" ] }, { "description": "The operational state of this Shelf. Refer to the X.731 standard." } ] }, "standbyState": { "type": "object", "allOf": [ { "title": "StandbyState6", "description": "The standby state of this Shelf. Refer to the X.731 standard.", "example": "providingService", "type": "string", "enum": [ "providingService", "standby" ] }, { "description": "The standby state of this Shelf. Refer to the X.731 standard." } ] }, "availabilityStates": { "description": "The availability states of this Shelf. Refer to the X.731 standard.", "type": "array", "items": { "title": "AvailabilityState", "type": "string", "enum": [ "unknown", "inTest", "failed", "degraded", "offLine", "powerOff", "offDuty", "dependency", "notInstalled", "logFull" ] } }, "stateReasons": { "description": "A set of specific reasons why the Shelf is in this state.", "type": "array", "items": { "type": "string" } }, "objectDetails": { "description": "Generic properties of this Shelf, specific to the Network Supervision application.", "type": "object", "additionalProperties": { "type": "string" } }, "manufacturer": { "description": "The vendor of the Shelf.", "type": "string" }, "serialNumber": { "description": "The serial number of the Shelf provided by the manufacturer.", "type": "string" }, "partNumber": { "description": "The part number of the Shelf provided by the manufacturer.", "type": "string" }, "manufacturerAssemblyNumber": { "description": "The assembly number of the Shelf provided by the manufacturer.", "type": "string" }, "manufactureDate": { "description": "The date of manufacture of the Shelf.", "type": "string" }, "manufacturingDeviations": { "description": "The manufacturing deviations of the Shelf provided by the manufacturer.", "type": "string" }, "macAddress": { "description": "The Base MAC Address of the Shelf", "type": "string" }, "hwMacAddress": { "description": "The Hardware MAC Address of the Shelf", "type": "string" } }, "required": [ "fdn", "sourceType", "sourceSystem", "sources", "name", "neName", "neId", "positionId", "position", "adminState", "operState", "standbyState", "availabilityStates" ] } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getShelvesUsingGET" }, "task": true }, { "name": "getShelfUsingGET", "summary": "getShelfUsingGET", "description": "Returns detailed information for the specified shelf. Example: GET /v1/shelves/fdn:model:equipment:Equipment:2122", "input": [ { "name": "shelfFdn", "type": "string", "info": "shelfFdn: string", "required": true, "schema": { "title": "shelfFdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getShelfUsingGET" }, "task": true } ], "views": [] }