@itentialopensource/adapter-nokia_nsp_network

{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/v1/cardSlots": { "get": { "tags": [ "CardSlots" ], "operationId": "getCardSlotsUsingGET", "description": "The parameters and request body are for method: getCardSlotsUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "neName": { "type": "string" }, "neId": { "type": "string" }, "description": { "type": "string" }, "positionId": { "type": "number" }, "position": { "type": "string" }, "adminState": { "type": "object" }, "operState": { "type": "object" }, "standbyState": { "type": "object" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "stateReasons": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "manufacturer": { "type": "string" }, "serialNumber": { "type": "string" }, "partNumber": { "type": "string" }, "manufacturerAssemblyNumber": { "type": "string" }, "manufactureDate": { "type": "string" }, "manufacturingDeviations": { "type": "string" }, "macAddress": { "type": "string" }, "hwMacAddress": { "type": "string" }, "provisionedType": { "type": "string" }, "actualType": { "type": "string" }, "holderState": { "type": "string" } } } }, "example": [ { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 2, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "unknown", "notInstalled" ], "stateReasons": [ "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "provisionedType": "string", "actualType": "string", "holderState": "string" }, { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 9, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "offLine", "unknown" ], "stateReasons": [ "string", "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "provisionedType": "string", "actualType": "string", "holderState": "string" }, { "links": [ { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string", "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 10, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "inTest", "offLine", "offDuty", "degraded", "failed", "powerOff" ], "stateReasons": [ "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "provisionedType": "string", "actualType": "string", "holderState": "string" } ] } } } }, "parameters": [ { "name": "fdns", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/cardSlots/{cardSlotFdn}": { "get": { "tags": [ "CardSlots" ], "operationId": "getCardSlotUsingGET", "description": "The parameters and request body are for method: getCardSlotUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "cardSlotFdn", "in": "path", "required": true, "schema": { "title": "cardSlotFdn", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/cards": { "get": { "tags": [ "Cards" ], "operationId": "getCardsUsingGET", "description": "The parameters and request body are for method: getCardsUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "neName": { "type": "string" }, "neId": { "type": "string" }, "description": { "type": "string" }, "positionId": { "type": "number" }, "position": { "type": "string" }, "adminState": { "type": "object" }, "operState": { "type": "object" }, "standbyState": { "type": "object" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "stateReasons": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "manufacturer": { "type": "string" }, "serialNumber": { "type": "string" }, "partNumber": { "type": "string" }, "manufacturerAssemblyNumber": { "type": "string" }, "manufactureDate": { "type": "string" }, "manufacturingDeviations": { "type": "string" }, "macAddress": { "type": "string" }, "hwMacAddress": { "type": "string" }, "cardDetails": { "type": "object", "properties": { "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "cardType": { "type": "string" }, "equippedPorts": { "type": "number" }, "capabilities": { "type": "array", "items": { "type": "string" } }, "availableSlots": { "type": "number" }, "installedSlots": { "type": "number" }, "memorySize": { "type": "number" }, "lastBootUpReason": { "type": "string" } } } } } }, "example": [ { "links": [ { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string" ], "name": "string", "neName": "string", "neId": "string", "description": "string", "positionId": 7, "position": "string", "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "notInstalled" ], "stateReasons": [ "string", "string", "string", "string", "string" ], "objectDetails": {}, "manufacturer": "string", "serialNumber": "string", "partNumber": "string", "manufacturerAssemblyNumber": "string", "manufactureDate": "string", "manufacturingDeviations": "string", "macAddress": "string", "hwMacAddress": "string", "cardDetails": { "fdn": "fdn:model:equipment:CardDetails:2203", "sourceType": null, "sourceSystem": "fdn:realm:sam", "sources": [ "fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card@cardDetails" ], "objectDetails": {}, "cardType": "500g CPM / Switch Fabric 3", "equippedPorts": 40, "capabilities": [ "string", "string", "string", "string", "string", "string" ], "availableSlots": 2, "installedSlots": 1, "memorySize": 16392, "lastBootUpReason": "Hard Reboot" } } ] } } } }, "parameters": [ { "name": "fdns", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/cards/{cardFdn}": { "get": { "tags": [ "Cards" ], "operationId": "getCardUsingGET", "description": "The parameters and request body are for method: getCardUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "cardFdn", "in": "path", "required": true, "schema": { "title": "cardFdn", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/lags": { "get": { "tags": [ "Lags" ], "operationId": "getLAGsUsingGET", "description": "The parameters and request body are for method: getLAGsUsingGET. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "templated": { "type": "boolean" } } } }, "fdn": { "type": "string" }, "sourceType": { "type": "object" }, "sourceSystem": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "lagId": { "type": "string" }, "neName": { "type": "string" }, "neId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "configuredAddress": { "type": "string" }, "encapType": { "type": "object" }, "operationalSpeedUnits": { "type": "string" }, "operationalSpeed": { "type": "number" }, "lagMode": { "type": "object" }, "adminState": { "type": "object" }, "operState": { "type": "object" }, "standbyState": { "type": "object" }, "availabilityStates": { "type": "array", "items": { "type": "string" } }, "stateReasons": { "type": "array", "items": { "type": "string" } }, "objectDetails": { "type": "object" }, "members": { "type": "array", "items": { "type": "object", "properties": { "encapType": { "type": "string" }, "fdn": { "type": "string" }, "lagId": { "type": "string" }, "objectDetails": { "type": "object" }, "portFdn": { "type": "string" }, "portName": { "type": "string" }, "priority": { "type": "number" }, "sourceSystem": { "type": "string" }, "sourceType": { "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "standbyState": { "type": "string" } } } }, "multiChassisLAGMembers": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "fdn": { "type": "string" }, "lacpKey": { "type": "number" }, "objectDetails": { "type": "object" }, "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": "number" } } } }, "parentNe": { "type": "string" }, "parent": { "type": "string" } } } }, "example": [ { "links": [ { "href": "string", "rel": "string", "templated": true }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false }, { "href": "string", "rel": "string", "templated": false } ], "fdn": "string", "sourceType": null, "sourceSystem": "string", "sources": [ "string", "string", "string", "string" ], "lagId": "string", "neName": "string", "neId": "string", "name": "string", "description": "string", "configuredAddress": "string", "encapType": null, "operationalSpeedUnits": "string", "operationalSpeed": 5, "lagMode": null, "adminState": null, "operState": null, "standbyState": null, "availabilityStates": [ "failed", "inTest", "degraded", "notInstalled", "logFull", "dependency", "offLine", "unknown" ], "stateReasons": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "objectDetails": {}, "members": [ { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 1, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 4, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 10, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 5, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 8, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 5, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 9, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 4, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 3, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string" ], "standbyState": "string" }, { "encapType": "string", "fdn": "string", "lagId": "string", "objectDetails": {}, "portFdn": "string", "portName": "string", "priority": 4, "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string" ], "standbyState": "string" } ], "multiChassisLAGMembers": [ { "description": "string", "fdn": "string", "lacpKey": 9, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 2 }, { "description": "string", "fdn": "string", "lacpKey": 2, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 4 }, { "description": "string", "fdn": "string", "lacpKey": 1, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 9 }, { "description": "string", "fdn": "string", "lacpKey": 3, "objectDetails": {}, "peerIpAddress": "string", "peerNeId": "string", "remoteLagId": "string", "sourceSystem": "string", "sourceType": "string", "sources": [ "string", "string", "string", "string" ], "standbyState": "string", "systemId": "string", "systemPriority": 10 }, { "description": "string", "fdn": "string", "lacpKey": 1,