Summary
Set Leaf
Description
Set leaf and its values.
Route
POST /nso_manager/setLeaf/:adapterId
Roles
admin
Parameters
Details Example Schema
Name
Type
Required
Description
adapterId
string
yes
The host that the leaf should be applied to.
path
string
yes
The NSO (Network Services Orchestrator) path for the config. Wrap variable with !!.
value
string
yes
The value for the path. Wrap variables with !!.
variables
string
yes
Key value variable definition.
set
boolean
yes
True for create/update, False for delete.
dryRun
boolean
yes
True for dry-run, False for provision.
options
string
yes
Options: outformat, async, sync, no_overwrite, staging, dryrun.
Copied to Clipboard
{
"path": "/itential_commands/native2Pronghorn",
"value": "hostname%itential.com",
"variables": "action-type pyaction",
"set": true,
"dryRun": true,
"options": "no_overwrite"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"path": {
"title": "path",
"type": "string",
"examples": [
"/itential_commands/native2Pronghorn"
]
},
"value": {
"type": "string",
"examples": [
"hostname%itential.com"
]
},
"variables": {
"type": "string",
"examples": [
"action-type pyaction"
]
},
"set": {
"type": "boolean"
},
"dryRun": {
"type": "boolean"
},
"options": {
"type": "string",
"title": "options",
"enum": [
"outformat",
"async",
"sync",
"no_overwrite",
"staging",
"dryrun"
]
}
},
"required": [
"path",
"value",
"variables",
"set",
"dryRun",
"options"
],
"additionalProperties": false
}
Return
Details Example Schema
Name
Type
Description
status
object
Status of set leaf.
Copied to Clipboard
[
{
"action": "enim irure",
"path_raw": "mollit sed enim",
"path_evaluated": "deserunt dolor",
"value_raw": "officia",
"value_evaluated": "cupidatat in"
},
{
"action": "sint ut velit Lorem",
"path_raw": "nostrud eiusmod enim",
"path_evaluated": "Duis",
"value_raw": "amet",
"value_evaluated": "ea culpa in"
}
]
Copied to Clipboard
{
"oneOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "Action taken by NSO"
},
"path_raw": {
"type": "string",
"description": "The raw path provided by the call"
},
"path_evaluated": {
"type": "string",
"description": "The path with all of the variables replaced"
},
"value_raw": {
"type": "string",
"description": "The value provided by the call"
},
"value_evaluated": {
"type": "string",
"description": "The vlaue with the variables replaced"
}
}
}
}
]
}
