1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
{
"command": "config-file",
"operation": "save",
"description": "Save the current configuration to a file.",
"endpoint": "/config-file",
"method": "POST",
"request": {
"payload": {
"data": {
"op": "save",
"path": [],
"file": "/config/backup.config"
},
"key": "your-api-key"
},
"example": {
"with_file": {
"op": "save",
"path": [],
"file": "/config/backup.config"
},
"default_location": {
"op": "save",
"path": []
}
}
},
"response": {
"success": {
"success": true,
"data": "",
"error": null
},
"error": {
"success": false,
"data": null,
"error": "Failed to save configuration"
}
},
"parameters": {
"file": {
"type": "string",
"required": false,
"description": "Path to the file where configuration will be saved. If not provided, uses default location.",
"example": "/config/backup.config"
},
"path": {
"type": "array",
"required": false,
"description": "Path parameter (required by API, typically empty array)",
"default": [],
"example": []
}
},
"python_usage": "device.config_file_save(file=\"/config/backup.config\")",
"notes": "The path parameter is required by the VyOS API even though it's typically empty for save operations."
}
|
