deviceManagerDoc

Copied to Clipboard

{ "$id": "deviceManagerDoc", "title": "device manager document", "description": "A Device Manager Document", "type": "object", "properties": {}, "definitions": { "adapter": { "type": "string", "example": [ "localNSO" ] }, "ned": { "type": "string", "examples": [ "nso46" ] }, "host": { "type": "string", "examples": [ "Local Host" ] }, "detailedNED": { "type": "object", "properties": { "ned_id": { "type": "string", "examples": [ "a10-acos" ] }, "name": { "type": "string", "examples": [ "a10-acos" ] }, "version": { "type": "string", "examples": [ "3.12" ] }, "host": { "$ref": "#/definitions/ned" } } }, "neds": { "type": "array", "items": { "$ref": "#/definitions/ned" } }, "deviceName": { "type": "string", "examples": [ "a10-acos-1" ] }, "authgroup": { "type": "string", "examples": [ "csr-aws", "default" ] }, "authgroups": { "type": "array", "items": { "$ref": "#/definitions/authgroup" } }, "deviceGroups": { "type": "array", "items": { "$ref": "#/definitions/deviceGroup" } }, "detailedDeviceGroup": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "group1" ] }, "devices": { "$ref": "#/definitions/devices" }, "host": { "$ref": "#/definitions/ned" }, "deviceGroups": { "$ref": "#/definitions/deviceGroups" } } }, "detailedDevice": { "type": "object", "properties": { "name": { "$ref": "#/definitions/deviceName" }, "authgroup": { "$ref": "#/definitions/authgroup" }, "address": { "type": "string", "examples": [ "127.0.0.1" ] }, "port": { "type": "string", "examples": [ "12035" ] }, "device-type": { "type": "string", "examples": [ "netconf" ] }, "ned": { "$ref": "#/definitions/ned" }, "admin": { "type": "boolean" }, "host": { "$ref": "#/definitions/host" }, "groups": { "$ref": "#/definitions/deviceGroups" } } }, "devices": { "type": "array", "items": { "$ref": "#/definitions/deviceName" } }, "config": { "type": "object", "properties": { "config": { "type": "string", "examples": [ "hostname bob" ] } } }, "template": { "type": "string", "examples": [ "testTemplate" ] }, "variables": { "type": "object", "properties": { "variable": { "type": "string", "examples": [ "variable1" ] } } }, "deviceGroup": { "type": "string", "examples": [ "Group1" ] }, "options": { "type": "object", "properties": { "start": { "type": "integer", "examples": [ 1 ] }, "limit": { "type": "integer", "examples": [ 2 ] }, "filter": { "type": "object", "properties": {} }, "sort": { "type": "array", "items": {} }, "order": { "type": "string", "examples": [ "ascending" ] }, "entity": { "type": "string", "examples": [ "entity1" ] } } }, "backup": { "type": "object", "properties": { "code": { "type": "integer", "examples": [ 200 ] }, "value": { "type": "object", "properties": { "_id": { "type": "string", "examples": [ "86e543a6-ca02-4801-89d6-afbad7718fa7" ] }, "name": { "type": "string", "examples": [ "xr0" ] }, "host": { "type": "string", "examples": [ "nso46" ] }, "timestamp": { "type": "integer", "examples": [ 1555518710188 ] }, "date_string": { "type": "string", "examples": [ "2019-4-17 16:31:50" ] }, "type": { "type": "string", "examples": [ "json" ] } } } } }, "deviceInfo": { "type": "object", "properties": { "name": { "$ref": "deviceManagerDoc#/definitions/deviceName" }, "host": { "$ref": "deviceManagerDoc#/definitions/host" }, "address": { "type": "string", "examples": [ "3000" ] }, "port": { "type": "string", "examples": [ "42" ] }, "authgroup": { "$ref": "deviceManagerDoc#/definitions/authgroup" }, "protocol": { "type": "string", "examples": [ "protocol1" ] }, "ned": { "$ref": "deviceManagerDoc#/definitions/ned" }, "device-type": { "type": "string", "examples": [ "type1" ] }, "tenant": { "type": "string", "examples": [ "tenant1" ] } } }, "syncStatus": { "type": "object", "properties": { "code": { "type": "integer", "examples": [ 200 ] }, "value": { "type": "array", "items": { "type": "object", "properties": { "devicename": { "$ref": "deviceManagerDoc#/definitions/deviceName" }, "synstatus": { "type": "string", "examples": [ "in-sync" ] } } } } } }, "syncFrom": { "type": "object", "properties": { "jsonrpc": { "type": "string", "examples": [ "2.0" ] }, "result": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "result" ] }, "value": { "type": "string", "examples": [ "true" ] } } } }, "id": { "type": "integer" } } } } }