mopTemplateDoc

Copied to Clipboard

{ "$id": "mopTemplateDoc", "title": "mop template", "description": "A mop template object", "type": "object", "properties": { "_id": { "$ref": "#/definitions/_id" }, "name": { "$ref": "#/definitions/name" }, "namespace": { "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/projectNamespace" } ] }, "os": { "type": "string", "examples": [ "cisco-ios" ] }, "passRule": { "type": "boolean" }, "commands": { "type": "array", "items": { "$ref": "#/definitions/command" } }, "created": { "type": "integer", "examples": [ 1508182880981 ] }, "createdBy": { "type": "string", "examples": [ "exampleUser" ] }, "lastUpdated": { "type": "integer", "examples": [ 1508182880981 ] }, "lastUpdatedBy": { "type": "string", "examples": [ "exampleUser" ] } }, "required": [ "name" ], "definitions": { "accessControl": { "type": "object", "properties": { "read": { "type": "array", "items": { "type": "string" } }, "execute": { "type": "array", "items": { "type": "string" } }, "write": { "type": "array", "items": { "type": "string" } }, "manage": { "type": "array", "items": { "type": "string" } } } }, "projectNamespace": { "type": "object", "required": [], "properties": { "type": { "const": "project" }, "_id": { "type": "string", "examples": [ "5cb5252a1bbc5a00def564c1" ] }, "name": { "type": "string" }, "accessControl": { "$ref": "#/definitions/accessControl" } } }, "_id": { "type": "string", "examples": [ "ASR1K-MOP" ] }, "name": { "type": "string", "examples": [ "ASR1K-MOP" ] }, "authgroup": { "type": "string", "examples": [ "csr-aws", "default" ] }, "host": { "type": "string", "examples": [ "Local Host" ] }, "ned": { "type": "string", "examples": [ "nso46" ] }, "deviceGroups": { "type": "array", "items": { "$ref": "#/definitions/deviceGroup" } }, "deviceGroup": { "type": "string", "examples": [ "Group1" ] }, "command": { "type": "object", "properties": { "command": { "type": "string", "examples": [ "show running-config ip vrf" ] }, "passRule": { "type": "boolean" }, "rules": { "$ref": "#/definitions/rules" } } }, "successResponse": { "type": "object", "properties": { "n": { "type": "integer", "examples": [ 1 ] }, "ok": { "type": "integer", "examples": [ 1 ] }, "nModified": { "type": "integer", "examples": [ 1 ] } } }, "variables": { "type": "object", "properties": {}, "examples": [ { "device_name": "my-device1" } ] }, "devices": { "type": "array", "items": { "type": "string", "examples": [ "Device 2", "Device 1" ] } }, "rules": { "type": "array", "items": { "type": "object", "properties": { "rule": { "type": "string", "examples": [ "show version" ] }, "eval": { "type": "string", "examples": [ "contains" ] }, "raw": { "type": "string", "examples": [ "show version" ] }, "result": { "type": "boolean" } } } }, "runCommandRes": { "type": "object", "properties": { "raw": { "type": "string", "examples": [ "show version" ] }, "all_pass_flag": { "type": "boolean" }, "evaluated": { "type": "string", "examples": [ "show version" ] }, "parameters": { "type": "object", "properties": {} }, "rules": { "$ref": "#/definitions/rules" }, "device": { "$ref": "#/definitions/device" }, "response": { "type": "string", "examples": [ "version: 10.0.0" ] }, "result": { "type": "boolean" } } }, "device": { "type": "string", "examples": [ "device1" ] }, "options": { "type": "object", "properties": { "start": { "type": "integer", "examples": [ 0 ] }, "limit": { "type": "integer", "examples": [ 25 ] }, "entity": { "type": "string", "examples": [ "device1" ] }, "filter": { "type": "string", "examples": [ "filter" ] }, "sort": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "integer", "examples": [ 1 ] } } } } } }, "detailedDevice": { "type": "object", "properties": { "name": { "$ref": "#/definitions/name" }, "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" } } } } }