Summary
Load native config
Description
Load native config into a device
Route
No Northbound API Available
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| deviceName |
string |
yes |
Device Name |
| config |
string |
yes |
Native Config as string or file path relative to NSO run directory |
| options |
object |
yes |
Options such as mode of loading config and request verbose |
Copied to Clipboard
{
"deviceName": "dolor sint ut",
"config": "dolor ut cillum nostrud",
"options": {
"mode": "qui",
"verbose": false,
"dry-run": "dolor veniam minim",
"isFile": true
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"deviceName": {
"type": "string"
},
"config": {
"type": "string"
},
"options": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"description": "Indicates the type of load action",
"enums": [
"merge",
"replace"
]
},
"verbose": {
"type": "boolean",
"description": "Indicates if verbose is needed or not"
},
"dry-run": {
"type": "string",
"description": "Indicates the format to get dry run in",
"enums": [
"cli",
"native",
"xml"
]
},
"isFile": {
"type": "boolean",
"description": "Indicates whether the string passed is file path or config",
"schema": {
"type": "boolean"
}
}
}
}
},
"required": [
"deviceName",
"config",
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
Returned result of loading the native config on a device |
Copied to Clipboard
{
"device": "device1",
"dry-run": "mollit"
}
Copied to Clipboard
{
"oneOf": [
{
"type": "object",
"description": "Result when commit is performed",
"properties": {
"status": {
"description": "Status of carrying out action",
"type": "boolean"
},
"result": {
"type": "array",
"description": "Array of results",
"items": {
"type": "object",
"description": "Details of changes made if verbose is requested",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"status",
"result"
]
},
{
"type": "object",
"description": "Result of dry-run if it is requested",
"properties": {
"device": {
"type": "string",
"description": "Device name",
"enum": [
"device1",
"device2",
"device3"
]
},
"dry-run": {
"type": "string",
"description": "Dry run changes"
}
},
"required": [
"device",
"dry-run"
]
}
]
}
