serviceManagerDoc

Copied to Clipboard

{ "$id": "serviceManagerDoc", "title": "service manager document", "description": "A Service Manager Document", "type": "object", "properties": {}, "definitions": { "serviceModel": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "/ncs:services/itential-demo-l2vpn:l2vpn" ] }, "hosts": { "type": "array", "items": { "type": "string", "examples": [ "nso46", "nso45" ] } } } }, "serviceModels": { "type": "array", "items": { "$ref": "#/definitions/serviceModel" } }, "serviceModelDetails": { "type": "object", "properties": { "children": { "type": "array", "items": { "type": "object", "properties": {} } }, "type": { "type": "string", "examples": [ "service" ] }, "name": { "type": "string", "examples": [ "l2vpn" ] } } }, "serviceInstance": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "datatypes" ] }, "key_type": { "type": "string", "examples": [ "service-name" ] }, "key_value": { "type": "string", "examples": [ "largeone" ] }, "devices": { "type": "array", "items": {} } } }, "testInstanceOptions": { "type": "object", "title": "Test Instance Options", "description": "Optional parameters for testInstances.", "properties": { "force": { "type": "boolean", "description": "Use no-out-of-sync-check commit flag." }, "outformat": { "type": "string", "description": "Use dryrun commit flag and set results outformat to cli, native, or xml. If not set, defaults to native.", "enum": [ "cli", "native", "xml" ] }, "reverse": { "type": "boolean", "description": "Use the reverse commit flag. Requires dryrun to be set." }, "raw": { "type": "boolean", "description": "Sets dryrun output to raw mode. Only works when dryrun outformat is set to native." } } }, "saveInstanceOptions": { "type": "object", "title": "Save Instance Options", "description": "Optional parameters for saveInstances.", "properties": { "sync": { "type": "boolean", "description": "Set to false to use commit-queue async mode if global Commit Queue property is set to true (default)." }, "commit-sync": { "type": "boolean", "description": "Use commit-queue sync mode." }, "no_overwrite": { "type": "boolean", "description": "Use no-overwrite commit flag." }, "staging": { "type": "boolean", "description": "Use no-networking commit flag." }, "force": { "type": "boolean", "description": "Use no-out-of-sync-check commit flag." } } }, "path": { "type": "string", "examples": [ "directory/example" ] }, "format": { "type": "string", "examples": [ "xml" ] }, "host": { "type": "string", "examples": [ "Local NSO" ] }, "instance": { "type": "object", "properties": { "servicePath": { "description": "The servicePath key is a service model's XPATH. The value is an array of objects. Each array element represents an instance of a service model.", "type": "array", "items": { "type": "object", "description": "An object representing an instance of a service model. Properties are specific to a service model." } } } } } }