UNPKG

@itentialopensource/adapter-nokia_nsp_device_configurator

Version:

This adapter integrates with system described as: 22.11Modeled-deviceConfiguratorRestconfApis.

1,377 lines 75.9 kB
{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/rest-gateway/rest/api/v1/auth/token": { "post": { "tags": [ "GetBearerToken" ], "operationId": "getAuthBearerToken", "description": "The parameters and request body are for method: getAuthBearerToken. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "refresh_token": { "type": "string" }, "token_type": { "type": "string" }, "expires_in": { "type": "number" } } }, "example": { "access_token": "VEtOLWFkbWluYjcxY2RiMzMtYWZkMS00ZGY2LWFlMDktMDBiNmQ5OTYwNGQ5", "refresh_token": "UkVUS04tYWRtaW41M2I3YWUwOS1iYzRlLTQ2N2UtOWEwYy0wMDljOTc0YjQ2YWY=", "token_type": "Bearer", "expires_in": 3600 } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/.well-known/host-meta": { "get": { "tags": [ "BasicRESTCONFFlow" ], "operationId": "gettheRESTCONFRoot", "description": "The parameters and request body are for method: gettheRESTCONFRoot. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "rel": { "type": "string" }, "href": { "type": "string" } } } } } }, "example": { "links": [ { "rel": "restconf", "href": "/restconf" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/restconf": { "get": { "tags": [ "BasicRESTCONFFlow" ], "operationId": "getthedatastore", "description": "The parameters and request body are for method: getthedatastore. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ietf-restconf:restconf": { "type": "object", "properties": { "data": { "type": "object" }, "yang-library-version": { "type": "string" } } } } }, "example": { "ietf-restconf:restconf": { "data": {}, "yang-library-version": "2019-01-04" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/restconf/data/ietf-yang-library:yang-library": { "get": { "tags": [ "BasicRESTCONFFlow" ], "operationId": "gettheyangLibrary", "description": "The parameters and request body are for method: gettheyangLibrary. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ietf-yang-library:yang-library": { "type": "object", "properties": { "content-id": { "type": "string" }, "module-set": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "module": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "revision": { "type": "string" }, "namespace": { "type": "string" }, "conformance-type": { "type": "string" } } } } } } } } } } }, "example": { "ietf-yang-library:yang-library": { "content-id": "NSP-2019-05-20", "module-set": [ { "name": "NSP-MDC-2019-05-20", "module": [ { "name": "network-device-mgr", "revision": "2018-06-06", "namespace": "urn:nokia:nsp:mdm:network-device-mgr", "conformance-type": "implement" }, { "name": "ietf-yang-library", "revision": "2019-01-04", "namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-library", "conformance-type": "implement" }, { "name": "ietf-yang-schema-mount", "revision": "2017-10-09", "namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-schema-mount", "conformance-type": "implement" }, { "name": "ietf-restconf", "revision": "2016-08-15", "namespace": "urn:ietf:params:xml:ns:yang:ietf-restconf", "conformance-type": "implement" } ] } ] } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/restconf/data/ietf-yang-schema-mount:schema-mounts": { "get": { "tags": [ "BasicRESTCONFFlow" ], "operationId": "gettheschemamounts", "description": "The parameters and request body are for method: gettheschemamounts. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ietf-yang-schema-mounts:schema-mounts": { "type": "object", "properties": { "mount-point": { "type": "array", "items": { "type": "object", "properties": { "module": { "type": "string" }, "label": { "type": "string" }, "inline": { "type": "object" } } } } } } } }, "example": { "ietf-yang-schema-mounts:schema-mounts": { "mount-point": [ { "module": "ietf-network", "label": "ne-management-nm", "inline": {} }, { "module": "nsp-network", "label": "node-root", "inline": {} }, { "module": "ietf-network", "label": "system-root", "inline": {} }, { "module": "ietf-network", "label": "protocol-root", "inline": {} }, { "module": "ietf-network", "label": "port-root", "inline": {} }, { "module": "ietf-network", "label": "interfaces-root", "inline": {} }, { "module": "ietf-network", "label": "routing-root", "inline": {} }, { "module": "nsp-service-intent", "label": "intent", "inline": {} }, { "module": "nsp-tunnel-intent", "label": "intent", "inline": {} }, { "module": "network-device-mgr", "label": "root", "inline": {} } ] } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/restconf/data/network-device-mgr:network-devices": { "get": { "tags": [ "BasicRESTCONFFlow" ], "operationId": "getallthenetworkdevices", "description": "The parameters and request body are for method: getallthenetworkdevices. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "network-device-mgr:network-devices": { "type": "object", "properties": { "network-device": { "type": "array", "items": { "type": "object", "properties": { "neId": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "root": { "type": "object", "properties": { "yanglib:yang-library": { "type": "object", "properties": { "content-id": { "type": "string" }, "module-set": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "module": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "namespace": { "type": "string" }, "revision": { "type": "string" } } } } } } } } } } } } } } } } } }, "example": { "network-device-mgr:network-devices": { "network-device": [ { "neId": "10.10.10.1", "type": "SR-7750", "version": "20.10.R3", "root": { "yanglib:yang-library": { "content-id": "NSP-19.6.0", "module-set": [ { "name": "SrosOpenConfigMDCNBI@1.0.0", "module": [ { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" }, { "name": "openconfig-lacp", "namespace": "1.1.0", "revision": "1.1.0" }, { "name": "openconfig-network-instance", "namespace": "0.8.0", "revision": "0.8.0" }, { "name": "openconfig-relay-agent", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-routing-policy", "namespace": "3.0.0", "revision": "3.0.0" }, { "name": "openconfig-lldp", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-mpls", "namespace": "2.3.0", "revision": "2.3.0" }, { "name": "openconfig-acl", "namespace": "1.0.0", "revision": "1.0.0" }, { "name": "openconfig-bgp", "namespace": "3.0.1", "revision": "3.0.1" }, { "name": "openconfig-local-routing", "namespace": "1.0.1", "revision": "1.0.1" } ] } ] } } }, { "neId": "10.10.10.2", "type": "SR-7750", "version": "20.10.R3", "root": { "yanglib:yang-library": { "content-id": "NSP-19.6.0", "module-set": [ { "name": "SrosOpenConfigMDCNBI@1.0.0", "module": [ { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" }, { "name": "openconfig-lacp", "namespace": "1.1.0", "revision": "1.1.0" }, { "name": "openconfig-network-instance", "namespace": "0.8.0", "revision": "0.8.0" }, { "name": "openconfig-relay-agent", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-routing-policy", "namespace": "3.0.0", "revision": "3.0.0" }, { "name": "openconfig-lldp", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-mpls", "namespace": "2.3.0", "revision": "2.3.0" }, { "name": "openconfig-acl", "namespace": "1.0.0", "revision": "1.0.0" }, { "name": "openconfig-bgp", "namespace": "3.0.1", "revision": "3.0.1" }, { "name": "openconfig-local-routing", "namespace": "1.0.1", "revision": "1.0.1" } ] } ] } } } ] } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/restconf/data/network-device-mgr:network-devices/{pathv1}": { "get": { "tags": [ "BasicRESTCONFFlow" ], "operationId": "getagivennetworkdevice", "description": "The parameters and request body are for method: getagivennetworkdevice. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "network-device-mgr:network-device": { "type": "array", "items": { "type": "object", "properties": { "neId": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "root": { "type": "object", "properties": { "yanglib:yang-library": { "type": "object", "properties": { "content-id": { "type": "string" }, "module-set": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "module": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "namespace": { "type": "string" }, "revision": { "type": "string" } } } } } } } } } } } } } } } }, "example": { "network-device-mgr:network-device": [ { "neId": "10.10.10.1", "type": "SR-7750", "version": "20.10.R3", "root": { "yanglib:yang-library": { "content-id": "NSP-19.6.0", "module-set": [ { "name": "SrosOpenConfigMDCNBI@1.0.0", "module": [ { "name": "openconfig-interfaces", "namespace": "2.0.0", "revision": "2.0.0" }, { "name": "openconfig-lacp", "namespace": "1.1.0", "revision": "1.1.0" }, { "name": "openconfig-network-instance", "namespace": "0.8.0", "revision": "0.8.0" }, { "name": "openconfig-relay-agent", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-routing-policy", "namespace": "3.0.0", "revision": "3.0.0" }, { "name": "openconfig-lldp", "namespace": "0.1.0", "revision": "0.1.0" }, { "name": "openconfig-mpls", "namespace": "2.3.0", "revision": "2.3.0" }, { "name": "openconfig-acl", "namespace": "1.0.0", "revision": "1.0.0" }, { "name": "openconfig-bgp", "namespace": "3.0.1", "revision": "3.0.1" }, { "name": "openconfig-local-routing", "namespace": "1.0.1", "revision": "1.0.1" } ] } ] } } } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/restconf/data/network-device-mgr:network-devices/{pathv1}/root/nokia-conf:configure/{pathv2}": { "post": { "tags": [ "CreateConfigureAndDelete" ], "operationId": "createMDA", "description": "The parameters and request body are for method: createMDA. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "get": { "tags": [ "PlainPatch" ], "operationId": "verifyyangDataJsoninAcceptPatchheader", "description": "The parameters and request body are for method: verifyyangDataJsoninAcceptPatchheader. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "PlainPatch" ], "operationId": "patchMultipleinterfaces", "description": "The parameters and request body are for method: patchMultipleinterfaces. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/restconf/data/network-device-mgr:network-devices/{pathv1}/root/nokia-conf:configure/{pathv2}/{pathv3}": { "put": { "tags": [ "CreateConfigureAndDelete" ], "operationId": "configureMDA", "description": "The parameters and request body are for method: configureMDA. Same endpoint also used in methods:<br> createInterface (neId : string,router : string,interfaceParam : string,body : object)", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/restconf/data/network-device-mgr:network-devices/{pathv1}/root/nokia-conf:/configure/{pathv2}/{pathv3}": { "delete": { "tags": [ "CreateConfigureAndDelete" ], "operationId": "deleteMDA", "description": "The parameters and request body are for method: deleteMDA. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/restconf/data/network-device-mgr:network-devices/{pathv1}/root/nokia-conf:configure/{pathv2}/interface": { "get": { "tags": [ "PlainPatch" ], "operationId": "getthelistofinterfaces", "description": "The parameters and request body are for method: getthelistofinterfaces. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "nokia-conf:interface": { "type": "array", "items": { "type": "object", "properties": { "ipv4": { "type": "object", "properties": { "primary": { "type": "object", "properties": { "prefix-length": { "type": "number" }, "address": { "type": "string" } } } } }, "port": { "type": "string" }, "interface-name": { "type": "string" } } } } } }, "example": { "nokia-conf:interface": [ { "ipv4": { "primary": { "prefix-length": 24, "address": "10.0.0.2" } }, "port": "1/1/1", "interface-name": "if1" }, { "ipv4": { "primary": { "prefix-length": 24, "address": "10.18.1.1" } }, "interface-name": "plain_patch_1", "description": "To be modified by plain patch" }, { "ipv4": { "primary": { "prefix-length": 24, "address": "10.18.2.1" } }, "interface-name": "plain_patch_2", "description": "To be modified by plain patch" }, { "ipv4": { "primary": { "prefix-length": 24, "address": "10.18.3.1" } }, "interface-name": "plain_patch_3", "description": "To be modified by plain patch" }, { "ipv4": { "primary": { "prefix-length": 32, "address": "10.10.10.2" } }, "interface-name": "system" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/restconf/data/network-device-mgr:network-devices/{pathv1}/root/junos-conf-root:configuration/interfaces/{pathv2}": { "patch": { "tags": [ "PatchForLeafTypeEmpty" ], "operationId": "addEmptytype", "description": "The parameters and request body are for method: addEmptytype. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/restconf/data/network-device-mgr:network-devices/{pathv1}/root/junos-conf-root:configuration/interfaces/{pathv2}/disable": { "delete": { "tags": [ "PatchForLeafTypeEmpty" ], "operationId": "removeEmptytype", "description": "The parameters and request body are for method: removeEmptytype. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/restconf/data/network-device-mgr:network-devices/{pathv1}/root/nokia-conf:/configure/port": { "get": { "tags": [ "Search" ], "operationId": "fieldquerytoselectmultiplefieldsunderthetargetresource", "description": "The parameters and request body are for method: fieldquerytoselectmultiplefieldsunderthetargetresource. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "nokia-conf:port": { "type": "array", "items": { "type": "object", "properties": { "port-id": { "type": "string" }, "admin-state": { "type": "string" } } } } } }, "example": { "nokia-conf:port": [ { "port-id": "1/1/1", "admin-state": "enable" }, { "port-id": "1/1/9", "admin-state": "enable" }, { "port-id": "1/1/10", "admin-state": "enable" } ] } } } } }, "parameters": [ { "name": "fields", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/restconf/data/network-device-mgr:network-devices/{pathv1}/root/nokia-conf:/configure/{pathv2}": { "get": { "tags": [ "Search" ], "operationId": "fieldquerywithsubSelectorsofanodeunderthetargetresource", "description": "The parameters and request body are for method: fieldquerywithsubSelectorsofanodeunderthetargetresource. Same endpoint also used in methods:<br> fieldQueryToRetrieveASingleChildNodeUnderTheTargetResource (fields : string,neId : string,port : string)", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "nokia-conf:card": { "type": "array", "items": { "type": "object", "properties": { "slot-number": { "type": "string" }, "mda": { "type": "array", "items": { "type": "object", "properties": { "mda-slot": { "type": "number" }, "mda-type": { "type": "string" } } } } } } } } }, "example": { "nokia-conf:card": [ { "slot-number": "1", "mda": [ { "mda-slot": 1, "mda-type": "m60-10/100eth-tx" }, { "mda-slot": 2, "mda-type": "m10-1gb+1-10gb" } ] } ] } } } } }, "parameters": [ { "name": "fields", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/restconf/data/network-device-mgr:network-devices/{pathv1}/root/nokia-conf:configure/qos": { "get": { "tags": [ "QOSPolicyGetCreateEdit" ], "operationId": "getQoS", "description": "The parameters and request body are for method: getQoS. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "nokia-conf:qos": { "type": "object", "properties": { "sap-egress": { "type": "array", "items": { "type": "object", "properties": { "sap-egress-policy-name": { "type": "string" }, "description": { "type": "string" }, "policy-id": { "type": "number" }, "fc": { "type": "array", "items": { "type": "object", "properties": { "fc-name": { "type": "string" }, "queue": { "type": "number" } } } }, "queue": { "type": "array", "items": { "type": "object", "properties": { "queue-id": { "type": "number" }, "rate": { "type": "object", "properties": { "pir": { "type": "string" }, "cir": { "type": "string" } } }, "adaptation-rule": { "type": "object", "properties": { "pir": { "type": "string" }, "cir": { "type": "string" } } }, "queue-type": { "type": "string" } } } } } } }, "sap-ingress": { "type": "array", "items": { "type": "object", "properties": { "ip-criteria": { "type": "object", "properties": { "entry": { "type": "array", "items": { "type": "object", "properties": { "entry-id": { "type": "number" }, "match": { "typ