DLI EPCDC32 Object Model Reference
|
object | system/ |
Object representing the system management state and configuration |
Retrieving the value is denied if not administrative user
This object contains the following items:
Sample uom
library write command:
uom.system=<...>
Sample JS request
read command:
request.get({url:"system/"},function(error,response,body) {console.log(body)});
⇒
<...>
number | system/time/ |
The current system time |
The value represents time, the standard unit of which is the second (s).
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number can change as if by itself or indirectly because of other actions.
Changes to this number cannot be tracked.
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/system/time/"
⇒
1677492132.68
Sample CLI write command:
uom set "system/time" "1771910029.04"
number | system/uptime/ |
The time since latest system reboot |
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater or equal to 0
Retrieving the value is denied if not administrative user
This number does not support direct modification.
This number can change as if by itself or indirectly because of other actions.
Changes to this number cannot be tracked.
Sample uom
library read command:
print(uom.dump(uom.system.uptime))
⇒
148590130.1
Sample JS request
read command:
request.get({url:"system/uptime/"},function(error,response,body) {console.log(body)});
⇒
50069109.05
map | system/uploads/ |
Uploaded files |
Retrieving the value is denied if not administrative user
This map does not support direct modification.
This map can change as if by itself or indirectly because of other actions.
Changes to this map cannot be tracked.
This map contains Expiration time elements.
Creating elements in this collection is not supported.
Sample CLI read command:
uom get "system/uploads"
⇒
{"/tmp/uploads/.tmp-uploadzquQ6n":16.23,"/tmp/uploads/.tmp-uploadAR87KD":17.02,"/tmp/uploads/.tmp-uploadA15F87":50.6,"/tmp/uploads/.tmp-uploadTajWV9":6.52,"/tmp/uploads/.tmp-uploadzbEDwh":72.43}
Sample uom
library read command:
print(uom.dump(uom.system.uploads))
⇒
number | system/uploads/S/ |
The time after which the file is to be deleted |
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater than 0
Sample curl
read command (note that :expiration_time
is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/system/uploads/:expiration_time/"
⇒
100.56
Sample JS request
read command (note that _expiration_time
is a variable):
request.get({url:"system/uploads/"+_expiration_time+"/"},function(error,response,body) {console.log(body)});
⇒
28.83
call | system/upload_file/ |
Store the file in temporary storage for a given amount of time |
Performing the function call is denied if not administrative user
The call accepts the following arguments:
The call returns the following results:
Sample requests
invocation:
print(requests.post('http://192.168.0.100/restapi/system/upload_file/',auth=auth,headers=headers,json=['81a8d2fe6d9af5cf6c180bb2796d79358bed12a2667acda7a58555d6ea5dd12dbb69f8a86222b083e6293b13e5dae345de73fbbdb2ce70c488b113fd5bac02a8e76ba8a30af123142b0cb516d4503fb8da13644ebb85e62118c10f2a384f24d382357537bb6335fd1c6d03e1cef91c3cd123965c0b7001fe28fc647098be5b160058a5cb5468ef4bf34f58', 9]).json())
⇒
'/tmp/uploads/.tmp-uploadAtSfgt'
Sample uom
library invocation:
print(uom.dump(uom.system.upload_file("96fcd647e1f23b9d577cd6ef843d14bbb0eba1e5c0169d627f8932f21c1b293955331fc3489d41ce014cf3fcb7cdd12d50e9426077a9691c1b0fa400ff033f9de746ce863cb12994840df7adbb69f24de19908016e404f62d3ae40d3d491b028035f7cdafba452684992106dd2bff7486cac5dde8f7a1203cedf20ecc4a2ba54ff77fbec7a1f44cdf62c2f8109b753971ae476e8302eae2dfe0267bcac08921e5886afc23edfbe90aa9806e6101e680e3b281a8603724e20edae4e53a391816247a003a7cfe35b2321e402168b2210b8feb48c05b2f0c1c58538bdf4296e88",71)))
⇒
"/tmp/uploads/.tmp-uploadu4ky5g"
string | system/upload_file/arguments: 1/ |
File content |
The value contains application/octet-stream data.
This string does not correspond to an actual resource.
number | system/upload_file/arguments: 2/ |
The time after which the file is to be deleted |
The value represents time, the standard unit of which is the second (s).
The value is subject to the following constraints: the value is greater than 0
This number does not correspond to an actual resource.
string | system/upload_file/results: 1/ |
Name of the uploaded file |
The value is subject to the following constraints: uploads[the value]
This string does not correspond to an actual resource.
call | system/remove_uploaded_file/ |
Remove file from temporary storage |
Performing the function call is denied if not administrative user
The call accepts the following arguments:
The call returns the following results:
Sample curl
invocation:
curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[\"/tmp/uploads/.tmp-uploadwGq2b1\"]" "http://192.168.0.100/restapi/system/remove_uploaded_file/"
⇒
null
Sample JS request
invocation:
request.post({url:"system/remove_uploaded_file/",body:["/tmp/uploads/.tmp-uploadIk3cYZ"]});
⇒
null
string | system/remove_uploaded_file/arguments: 1/ |
Name of the uploaded file to be removed (if invalid, the call has no effect) |
This string does not correspond to an actual resource.
constant null | system/remove_uploaded_file/results: 1/ |
No additional information available |
This constant does not correspond to an actual resource.
call | system/verify_upgrade/ |
Check that system upgrade from a file in temporary storage is possible |
Performing the function call is denied if any of the following is true:
The call accepts the following arguments:
The call returns the following results:
Sample CLI invocation:
uom invoke "system/verify_upgrade" "\"/tmp/uploads/.tmp-uploadB1G7zN\""
⇒
[true,"verify_upgrade succeeded"]
Sample requests
invocation:
print(requests.post('http://192.168.0.100/restapi/system/verify_upgrade/',auth=auth,headers=headers,json=['/tmp/uploads/.tmp-uploadoYl0vu']).json())
⇒
[True, 'verify_upgrade succeeded']
string | system/verify_upgrade/arguments: 1/ |
System upgrade image filename |
The value is subject to the following constraints: uploads[the value]
This string does not correspond to an actual resource.
See also Verify upgrade image: System upgrade verification status
tuple | system/verify_upgrade/results: 1/ |
Status of the system upgrade verification |
This tuple does not correspond to an actual resource.
This tuple contains the following items:
1 | Status |
2 | Message |
sum (boolean) | system/verify_upgrade/results: 1/1/ |
Indicates whether the call succeeded |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant true | Succeeded | The call succeeded (but not necessarily completed) | |
constant false | Failed | The call failed (additional information in the message) |
string | system/verify_upgrade/results: 1/2/ |
Call status message |
This string does not correspond to an actual resource.
call | system/upgrade/ |
Perform system upgrade from a file in temporary storage |
Performing the function call is denied if any of the following is true:
The call accepts the following arguments:
The call returns the following results:
Sample requests
invocation:
print(requests.post('http://192.168.0.100/restapi/system/upgrade/',auth=auth,headers=headers,json=['/tmp/uploads/.tmp-uploadnmtydj']).json())
⇒
[True, 'upgrade succeeded']
Sample CLI invocation:
uom invoke "system/upgrade" "\"/tmp/uploads/.tmp-uploadq1lrzU\""
⇒
[false,"upgrade failed"]
string | system/upgrade/arguments: 1/ |
System upgrade image filename |
The value is subject to the following constraints: uploads[the value]
This string does not correspond to an actual resource.
See also Upgrade from file: System upgrade status
tuple | system/upgrade/results: 1/ |
Status of the system upgrade |
This tuple does not correspond to an actual resource.
This tuple contains the following items:
1 | Status |
2 | Message |
sum (boolean) | system/upgrade/results: 1/1/ |
Indicates whether the call succeeded |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant true | Succeeded | The call succeeded (but not necessarily completed) | |
constant false | Failed | The call failed (additional information in the message) |
string | system/upgrade/results: 1/2/ |
Call status message |
This string does not correspond to an actual resource.
sum (boolean) | system/preserve_packages/ |
Save a list of packages manually installed by the user, download and install them again on system upgrade |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
constant true | Enabled | The feature is enabled | |
constant false | Disabled | The feature is disabled |
Sample curl
write command:
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[]" "http://192.168.0.100/restapi/system/preserve_packages/"
Sample uom
library write command:
uom.system.preserve_packages={}
call | system/apply_maintenance_file/ |
Perform maintenance from a file in temporary storage |
Performing the function call is denied if any of the following is true:
The call accepts the following arguments:
The call returns the following results:
Sample curl
invocation:
curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[\"/tmp/uploads/.tmp-uploadDhv6hU\",false]" "http://192.168.0.100/restapi/system/apply_maintenance_file/"
⇒
[false,"maintenance failed"]
Sample CLI invocation:
uom invoke "system/apply_maintenance_file" "\"/tmp/uploads/.tmp-uploadQptYDa\"" "false"
⇒
[false,"maintenance failed"]
string | system/apply_maintenance_file/arguments: 1/ |
Maintenance filename |
The value is subject to the following constraints: uploads[the value]
This string does not correspond to an actual resource.
sum (boolean) | system/apply_maintenance_file/arguments: 2/ |
Ask the user for confirmation (if enabled in the maintenance package) |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant true | Enabled | The feature is enabled | |
constant false | Disabled | The feature is disabled |
See also Apply maintenance file: Maintenance status
tuple | system/apply_maintenance_file/results: 1/ |
Status of the maintenance |
This tuple does not correspond to an actual resource.
This tuple contains the following items:
1 | Status |
2 | Message |
sum (boolean) | system/apply_maintenance_file/results: 1/1/ |
Indicates whether the call succeeded |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant true | Succeeded | The call succeeded (but not necessarily completed) | |
constant false | Failed | The call failed (additional information in the message) |
string | system/apply_maintenance_file/results: 1/2/ |
Call status message |
This string does not correspond to an actual resource.
call | system/apply_maintenance_code/ |
Perform maintenance using a code |
Performing the function call is denied if any of the following is true:
The call accepts the following arguments:
The call returns the following results:
Sample CLI invocation:
uom invoke "system/apply_maintenance_code" "\"Xotqj<H`$YZdQF2Sk;}\\\"\"" "false"
⇒
[true,"maintenance succeeded"]
Sample JS request
invocation:
request.post({url:"system/apply_maintenance_code/",body:["AHg6r6lb+X>#,z:{Dwn#P'gK%nTJ",false]});
⇒
[false,"maintenance failed"]
string | system/apply_maintenance_code/arguments: 1/ |
Maintenance code |
This string does not correspond to an actual resource.
sum (boolean) | system/apply_maintenance_code/arguments: 2/ |
Ask the user for confirmation (if enabled in the maintenance package) |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant true | Enabled | The feature is enabled | |
constant false | Disabled | The feature is disabled |
See also Apply maintenance code: Maintenance status
tuple | system/apply_maintenance_code/results: 1/ |
Status of the maintenance |
This tuple does not correspond to an actual resource.
This tuple contains the following items:
1 | Status |
2 | Message |
sum (boolean) | system/apply_maintenance_code/results: 1/1/ |
Indicates whether the call succeeded |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant true | Succeeded | The call succeeded (but not necessarily completed) | |
constant false | Failed | The call failed (additional information in the message) |
string | system/apply_maintenance_code/results: 1/2/ |
Call status message |
This string does not correspond to an actual resource.
call | system/enumerate_configuration/ |
Retrieve a map of the currently existing configuration elements and their state |
Performing the function call is denied if not administrative user
The call has no arguments (supply empty tuple).
The call returns the following results:
Sample uom
library invocation:
print(uom.dump(uom.system.enumerate_configuration()))
⇒
{["/etc/config/0bPR2c"]={mode=null,modified=false,name="Sensor configuration",orig_mode=null,private=true},["/storage/3KFrJ"]={mode="d-wxrw-r-x",modified=false,name="HTTP file",orig_mode="d-wxrw-r-x",private=false}}
Sample CLI invocation:
uom invoke "system/enumerate_configuration"
⇒
{"/storage/779oFG1yNg":{"name":"Script file","modified":false,"mode":null,"orig_mode":null,"private":false}}
map | system/enumerate_configuration/results: 1/ |
Currently known configuration elements |
This map does not correspond to an actual resource.
This map contains Element elements.
See also Elements: Element
object | system/enumerate_configuration/results: 1/S/ |
Configuration element state |
This object does not correspond to an actual resource.
This object contains the following items:
name | Name |
mode | Element mode, if any |
orig_mode | Original element mode, if any |
modified | Modification flag |
private | Sensitive information flag |
string | system/enumerate_configuration/results: 1/S/name/ |
Human-readable element name |
This string does not correspond to an actual resource.
sum (optional string) | system/enumerate_configuration/results: 1/S/mode/ |
Current element file mode, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | Absent | The element is absent | |
string | File | Regular file | the value matches ^-[r-][w-][xsS-][r-][w-][xsS-][r-][w-][xtT-]$ |
string | Directory | Directory or other logical grouping of files | the value matches ^d[r-][w-][xsS-][r-][w-][xsS-][r-][w-][xtT-]$ |
constant "lrwxrwxrwx" | Symlink | Symbolic link to location in data |
sum (optional string) | system/enumerate_configuration/results: 1/S/orig_mode/ |
Factory default element file mode, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | Absent | The element was absent | |
string | File | Regular file | the value matches ^-[r-][w-][xsS-][r-][w-][xsS-][r-][w-][xtT-]$ |
string | Directory | Directory or other logical grouping of files | the value matches ^d[r-][w-][xsS-][r-][w-][xsS-][r-][w-][xtT-]$ |
constant "lrwxrwxrwx" | Symlink | Symbolic link to location in data |
sum (boolean) | system/enumerate_configuration/results: 1/S/modified/ |
Flag indicating if the element has been modified from the factory default configuration |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant true | Modified | The element was modified | |
constant false | Original | The element was not modified |
sum (boolean) | system/enumerate_configuration/results: 1/S/private/ |
Flag indicating if the element may contain sensitive information |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant true | Private | The element may contain sensitive information | |
constant false | Ordinary | The element likely doesn't contain sensitive information |
call | system/create_backup/ |
Create a backup of selected parts of the current configuration |
Performing the function call is denied if not administrative user
The call accepts the following arguments:
The call returns the following results:
Sample CLI invocation:
uom invoke "system/create_backup" "{\"/storage/gFscc9\":true,\"/storage/jTmI5C\":true,\"/etc/config/OekTRB5OIuhJ\":true}"
⇒
Sample JS request
invocation:
request.post({url:"system/create_backup/",body:[{"/storage/Hcs4XkLA":true,"/storage/GbmMeTdyi9":true,"/etc/BuWR4VC05Ym":true,"/etc/config/uUZvzwK":true}]});
⇒
See also Create backup of configuration: Elements
constant "application/octet-stream" | system/create_backup/results: 1/ |
The content type of the generated backup |
The value is subject to the following constraints: the value is equal to application/octet-stream
This constant does not correspond to an actual resource.
string | system/create_backup/results: 2/ |
File content |
The value contains application/octet-stream data.
This string does not correspond to an actual resource.
map | system/create_backup/arguments: 1/ |
Configuration elements chosen for backup |
This map does not correspond to an actual resource.
This map contains Chosen elements.
constant true | system/create_backup/arguments: 1/S/ |
The element is chosen to be backed up |
This constant does not correspond to an actual resource.
call | system/enumerate_backup/ |
Compare backup contents to current configuration state and return resolution status |
Performing the function call is denied if any of the following is true:
The call accepts the following arguments:
The call returns the following results:
Sample JS request
invocation:
request.post({url:"system/enumerate_backup/",body:["/tmp/uploads/.tmp-uploadveY0z5","next_unresolved",true]});
⇒
"Something went wrong"
Sample uom
library invocation:
print(uom.dump(uom.system.enumerate_backup("/tmp/uploads/.tmp-uploadeVhISW","next_unresolved",true)))
⇒
"Something went wrong"
string | system/enumerate_backup/arguments: 1/ |
Backup filename |
The value is subject to the following constraints: uploads[the value]
This string does not correspond to an actual resource.
sum (variant) | system/enumerate_backup/arguments: 2/ |
The set of files to be returned |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant true | All | Return information on all of the files | |
constant false | None | Return no information on the files, just check that the backup is valid | |
constant "resolved" | Resolved | Return information on all resolved files | |
constant "unresolved" | Unresolved | Return information on all unresolved files | |
constant "next_unresolved" | Next unresolved | Return information on the next set of unresolved files intended to be treated as a group | |
array | Selected | Return information on the files in this array |
See also File filter: Selected
sum (boolean) | system/enumerate_backup/arguments: 3/ |
Return options for unresolved elements |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant true | Enabled | The feature is enabled | |
constant false | Disabled | The feature is disabled |
sum (variant) | system/enumerate_backup/results: 1/ |
Backup enumeration result |
This sum does not correspond to an actual resource.
This sum can assume the following values:
map | Elements | Backup configuration elements | |
string | Enumeration failure | Enumeration failure status message |
See also Enumeration result: Elements
(possibly) array | system/enumerate_backup/arguments: 2/ |
Return information on the files in this array |
This array does not correspond to an actual resource.
This array contains Filename elements.
string | system/enumerate_backup/arguments: 2/N/ |
Return information on this file |
This string does not correspond to an actual resource.
(possibly) map | system/enumerate_backup/results: 1/S/resolution/ |
Resolution options |
This map does not correspond to an actual resource.
This map contains Option elements.
object | system/enumerate_backup/results: 1/S/resolution/S/ |
Resolution option |
This object does not correspond to an actual resource.
This object contains the following items:
provided | Presence flag |
mode | Element mode, if any |
data | Data |
badness | Badness |
sum (boolean) | system/enumerate_backup/results: 1/S/resolution/S/provided/ |
Flag indicating if the element data is provided in the response |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant true | Present | The element data is provided | |
constant false | Absent | The element data is not provided |
sum (optional string) | system/enumerate_backup/results: 1/S/resolution/S/mode/ |
Element file mode in this resolution option, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | Absent | The element does not exist | |
string | File | Regular file | the value matches ^-[r-][w-][xsS-][r-][w-][xsS-][r-][w-][xtT-]$ |
string | Directory | Directory or other logical grouping of files | the value matches ^d[r-][w-][xsS-][r-][w-][xsS-][r-][w-][xtT-]$ |
constant "lrwxrwxrwx" | Symlink | Symbolic link to location in data |
string | system/enumerate_backup/results: 1/S/resolution/S/data/ |
Element data, if exists and provided (or empty otherwise) |
This string does not correspond to an actual resource.
number | system/enumerate_backup/results: 1/S/resolution/S/badness/ |
Relative extent of resolution option demerit |
This number does not correspond to an actual resource.
(possibly) map | system/enumerate_backup/results: 1/ |
Backup configuration elements |
This map does not correspond to an actual resource.
This map contains Element elements.
object | system/enumerate_backup/results: 1/S/ |
Backup element data |
This object does not correspond to an actual resource.
This object contains the following items:
name | Name, if any |
group_name | Group name, if any |
resolution | Resolution option(s) |
sum (optional string) | system/enumerate_backup/results: 1/S/name/ |
Human-readable element name, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | Unknown | This element is not known | |
string | Name | Human-readable element name |
sum (optional string) | system/enumerate_backup/results: 1/S/group_name/ |
Human-readable element group name, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | None | This element does not belong to a group | |
string | Group name | Human-readable element group name |
sum (variant) | system/enumerate_backup/results: 1/S/resolution/ |
Resolution for resolved elements, or options for unresolved ones if requested |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant false | Unresolved | The element is resolved and option information not requested | |
map | Options | Resolution options | |
string | Resolution label | Label for a resolved backup element for reference |
See also Resolution option(s): Options
map | system/known_backup_resolution_options/ |
Known methods of resolving file content |
Retrieving the value is denied if not administrative user
This map is composite, i.e. is modified as a whole.
This map does not support direct modification.
This map contains Resolution option elements.
Creating elements in this collection is not supported.
Sample JS request
read command:
request.get({url:"system/known_backup_resolution_options/"},function(error,response,body) {console.log(body)});
⇒
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/system/known_backup_resolution_options/"
⇒
See also Known backup resolution options: Resolution option
object | system/known_backup_resolution_options/S/ |
Resolution option traits |
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
action | Action |
label | Label |
result | Result |
Sample requests
write command (note that _resolution_option
is a variable):
requests.put('http://192.168.0.100/restapi/system/known_backup_resolution_options/'+_resolution_option+'/',auth=auth,headers=headers,json={'result': 'merged', 'action': 'apply changes in the backup to our current file', 'label': 'current file with backup changes'})
Sample uom
library read command (note that _resolution_option
is a variable):
print(uom.dump(uom.system.known_backup_resolution_options[_resolution_option]))
⇒
{action="apply changes in the backup to our current file",label="current file with backup changes",result="merged"}
string | system/known_backup_resolution_options/S/action/ |
Backup resolution method action description |
This string is a part of a composite value which is modified as a whole.
Sample curl
write command (note that :resolution_option
is a URL template argument):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"replace with backup file\"" "http://192.168.0.100/restapi/system/known_backup_resolution_options/:resolution_option/action/"
Sample uom
library read command (note that _resolution_option
is a variable):
print(uom.dump(uom.system.known_backup_resolution_options[_resolution_option].action))
⇒
"apply changes in the backup to our current file"
string | system/known_backup_resolution_options/S/label/ |
Backup resolution method label |
This string is a part of a composite value which is modified as a whole.
Sample curl
read command (note that :resolution_option
is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/system/known_backup_resolution_options/:resolution_option/label/"
⇒
"current file"
Sample curl
write command (note that :resolution_option
is a URL template argument):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"backup original with our changes\"" "http://192.168.0.100/restapi/system/known_backup_resolution_options/:resolution_option/label/"
string | system/known_backup_resolution_options/S/result/ |
Backup resolution method resolution description |
This string is a part of a composite value which is modified as a whole.
Sample requests
write command (note that _resolution_option
is a variable):
requests.put('http://192.168.0.100/restapi/system/known_backup_resolution_options/'+_resolution_option+'/result/',auth=auth,headers=headers,json='unchanged')
Sample requests
read command (note that _resolution_option
is a variable):
print(requests.get('http://192.168.0.100/restapi/system/known_backup_resolution_options/'+_resolution_option+'/result/',auth=auth,headers=headers).json())
⇒
'merged'
call | system/resolve_backup_item/ |
Provide a resolution on an item |
Performing the function call is denied if any of the following is true:
The call accepts the following arguments:
The call returns the following results:
Sample requests
invocation:
print(requests.post('http://192.168.0.100/restapi/system/resolve_backup_item/',auth=auth,headers=headers,json=['/tmp/uploads/.tmp-upload6HkNm8', '/storage/DYurCiKGjl', 'our_orig_and_their_diff', 'our diff ']).json())
⇒
[False, 'resolve failed']
Sample CLI invocation:
uom invoke "system/resolve_backup_item" "\"/tmp/uploads/.tmp-uploadoi4nWc\"" "\"/etc/iXsGpHT\"" "\"our_file_and_their_diff\"" "\"their orig \""
⇒
[true,"resolve succeeded"]
string | system/resolve_backup_item/arguments: 1/ |
Backup filename |
The value is subject to the following constraints: uploads[the value]
This string does not correspond to an actual resource.
sum (optional string) | system/resolve_backup_item/arguments: 2/ |
Backup item, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | All unresolved items | Provide a resolution on all unresolved items where applicable | |
string | Item | Backup item |
string | system/resolve_backup_item/arguments: 3/ |
Backup item resolution option |
The value is subject to the following constraints: known backup resolution options[the value]
This string does not correspond to an actual resource.
sum (optional string) | system/resolve_backup_item/arguments: 4/ |
Backup item resolution label for reference, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | Default label | Use the default resolution option label | |
string | Resolution label | Backup item resolution label for reference |
See also Resolve backup item: Backup item resolution status
tuple | system/resolve_backup_item/results: 1/ |
Status of the backup item resolution |
This tuple does not correspond to an actual resource.
This tuple contains the following items:
1 | Status |
2 | Message |
sum (boolean) | system/resolve_backup_item/results: 1/1/ |
Indicates whether the call succeeded |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant true | Succeeded | The call succeeded (but not necessarily completed) | |
constant false | Failed | The call failed (additional information in the message) |
string | system/resolve_backup_item/results: 1/2/ |
Call status message |
This string does not correspond to an actual resource.
call | system/resolve_backup_item_with_content/ |
Provide a custom decision on an item (may not always be possible) |
Performing the function call is denied if any of the following is true:
The call accepts the following arguments:
The call returns the following results:
Sample CLI invocation:
uom invoke "system/resolve_backup_item_with_content" "\"/tmp/uploads/.tmp-uploadPuoL6C\"" "\"/storage/ksB-EuauVcZ\"" "\"d----w--w-\"" "\"c0d9451ab1b2f463ec5f803365e916c68589301d8a84d78180fbe3bbc847ed87304e93ec40736eb0395b6449d6ff2141bc11724b0bf87e7b6a2ee4b02cae6cc3efd1f11411839d5d27e59d7c39efc441dff21d9879900c332308ed8c3cf0b81194f527d59185056a27b7b958641b6b4c89d9c440e42a68cc5007b4f025c1d4dd397c8048425158aae8c7add136bdf8987acaf79abdde220ca2f4f55ae72f188bb71a159eb6789a0392358640cb63\"" "\"their diff \""
⇒
[false,"resolve failed"]
Sample uom
library invocation:
print(uom.dump(uom.system.resolve_backup_item_with_content("/tmp/uploads/.tmp-uploadPZTbse","/etc/pWa6a","--wxrw-r-x","61ea71f150b7e002f81093057774072f6ee2a0224dda959ae7982018c846a85e4627e412db666b1fb0bd1fcbe1b24a71b547dccc25a93631aded03c0b70d032f8bc08718b230fbcb8b19d5a6febc1951d3531cf2a4994347fe18353a44dc409361f5e6f9542a1c72d13d8eb46b8c45242a4293bb4ca9c8846ae5a24255c075b8","our orig and our orig")))
⇒
{true,"resolve succeeded"}
string | system/resolve_backup_item_with_content/arguments: 1/ |
Backup filename |
The value is subject to the following constraints: uploads[the value]
This string does not correspond to an actual resource.
string | system/resolve_backup_item_with_content/arguments: 2/ |
Backup item |
This string does not correspond to an actual resource.
sum (optional string) | system/resolve_backup_item_with_content/arguments: 3/ |
Element file mode in this resolution, if any |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant null | Absent | The element does not exist in this resolution | |
string | File | Regular file | the value matches ^-[r-][w-][xsS-][r-][w-][xsS-][r-][w-][xtT-]$ |
string | Directory | Directory or other logical grouping of files | the value matches ^d[r-][w-][xsS-][r-][w-][xsS-][r-][w-][xtT-]$ |
constant "lrwxrwxrwx" | Symlink | Symbolic link to location in data |
string | system/resolve_backup_item_with_content/arguments: 4/ |
Element data, if exists (or empty otherwise) |
This string does not correspond to an actual resource.
string | system/resolve_backup_item_with_content/arguments: 5/ |
Backup item resolution label for reference |
This string does not correspond to an actual resource.
See also Resolve backup item with custom content: Backup item resolution status
tuple | system/resolve_backup_item_with_content/results: 1/ |
Status of the backup item resolution |
This tuple does not correspond to an actual resource.
This tuple contains the following items:
1 | Status |
2 | Message |
sum (boolean) | system/resolve_backup_item_with_content/results: 1/1/ |
Indicates whether the call succeeded |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant true | Succeeded | The call succeeded (but not necessarily completed) | |
constant false | Failed | The call failed (additional information in the message) |
string | system/resolve_backup_item_with_content/results: 1/2/ |
Call status message |
This string does not correspond to an actual resource.
call | system/restore_backup/ |
Apply restoration of resolved configuration backup items and reboot |
Performing the function call is denied if any of the following is true:
The call accepts the following arguments:
The call returns the following results:
Sample uom
library invocation:
print(uom.dump(uom.system.restore_backup("/tmp/uploads/.tmp-upload9WGuyx")))
⇒
{false,"restore failed"}
Sample curl
invocation:
curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[\"/tmp/uploads/.tmp-uploadMjkklj\"]" "http://192.168.0.100/restapi/system/restore_backup/"
⇒
[true,"restore succeeded"]
string | system/restore_backup/arguments: 1/ |
Backup filename |
The value is subject to the following constraints: uploads[the value]
This string does not correspond to an actual resource.
See also Perform restoration of configuration from backup: Backup restore status
tuple | system/restore_backup/results: 1/ |
Status of the backup restore |
This tuple does not correspond to an actual resource.
This tuple contains the following items:
1 | Status |
2 | Message |
sum (boolean) | system/restore_backup/results: 1/1/ |
Indicates whether the call succeeded |
This sum does not correspond to an actual resource.
This sum can assume the following values:
constant true | Succeeded | The call succeeded (but not necessarily completed) | |
constant false | Failed | The call failed (additional information in the message) |
string | system/restore_backup/results: 1/2/ |
Call status message |
This string does not correspond to an actual resource.
call | system/reboot/ |
Reboot the unit |
Performing the function call is denied if not administrative user
The call has no arguments (supply empty tuple).
The call returns the following results:
Sample JS request
invocation:
request.post({url:"system/reboot/",body:[]});
⇒
null
Sample requests
invocation:
print(requests.post('http://192.168.0.100/restapi/system/reboot/',auth=auth,headers=headers,json={}).json())
⇒
None
constant null | system/reboot/results: 1/ |
No additional information available |
This constant does not correspond to an actual resource.
object | system/notifications/ |
System-related notifications |
Retrieving the value is denied if not administrative user
This object does not support direct modification.
This object contains the following items:
parameter_kinds | Parameter kinds |
events | Events |
Sample JS request
read command:
request.get({url:"system/notifications/"},function(error,response,body) {console.log(body)});
⇒
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/system/notifications/"
⇒
See also Notifications: Parameter kinds
map | system/notifications/events/ |
Event templates |
Retrieving the value is denied if not administrative user
This map is composite, i.e. is modified as a whole.
This map does not support direct modification.
This map contains Event elements.
Creating elements in this collection is not supported.
Sample JS request
read command:
request.get({url:"system/notifications/events/"},function(error,response,body) {console.log(body)});
⇒
Sample CLI read command:
uom get "system/notifications/events"
⇒
See also Events: Event
object | system/notifications/parameter_kinds/ |
Kinds of event parameters |
This object does not correspond to an actual resource.
This object contains the following items:
filename | Filename |
string | system/notifications/parameter_kinds/filename/ |
Path to the file involved |
object | system/notifications/events/S/parameters/N/ |
Properties of a parameter associated with the event |
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
id | Identifier |
has_fixed_value | Fixed value flag |
fixed_value | Fixed value |
Sample JS request
write command (note that _event
and _event_parameter_index
are variables):
request.put({url:"system/notifications/events/"+_event+"/parameters/"+_event_parameter_index.toString()+"/",body:{"has_fixed_value":false,"id":"filename"}});
Sample curl
write command (note that :event
and :event_parameter_index
are URL template arguments):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"has_fixed_value\":false,\"id\":\"filename\"}" "http://192.168.0.100/restapi/system/notifications/events/:event/parameters/:event_parameter_index/"
string | system/notifications/events/S/parameters/N/id/ |
Parameter identifier |
The value is subject to the following constraints: parameter kinds[the value]
Retrieving the value is denied if not administrative user
This string is a part of a composite value which is modified as a whole.
This string does not support direct modification.
Sample JS request
read command (note that _event
and _event_parameter_index
are variables):
request.get({url:"system/notifications/events/"+_event+"/parameters/"+_event_parameter_index.toString()+"/id/"},function(error,response,body) {console.log(body)});
⇒
"filename"
Sample requests
read command (note that _event
and _event_parameter_index
are variables):
print(requests.get('http://192.168.0.100/restapi/system/notifications/events/'+_event+'/parameters/'+str(_event_parameter_index)+'/id/',auth=auth,headers=headers).json())
⇒
'filename'
sum (boolean) | system/notifications/events/S/parameters/N/has_fixed_value/ |
Flag indicating that the parameter's value for this event is fixed |
Retrieving the value is denied if not administrative user
This sum is a part of a composite value which is modified as a whole.
This sum does not support direct modification.
This sum can assume the following values:
constant true | Fixed | The value is fixed | |
constant false | Variable | The value is variable |
Sample CLI read command (note that event
and event_parameter_index
are variables):
uom get "system/notifications/events/${event}/parameters/${event_parameter_index}/has_fixed_value"
⇒
false
Sample curl
read command (note that :event
and :event_parameter_index
are URL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/system/notifications/events/:event/parameters/:event_parameter_index/has_fixed_value/"
⇒
false
sum (variant) | system/notifications/events/S/parameters/N/fixed_value/ |
Fixed parameter value for this particular event |
Retrieving the value is denied if not administrative user
This sum is a part of a composite value which is modified as a whole.
This sum does not support direct modification.
This sum can assume the following values:
constant null | Null | Null | |
constant true | True | True | |
constant false | False | False | |
string | String | This string | |
number | Number | This number |
Sample requests
read command (note that _event
and _event_parameter_index
are variables):
print(requests.get('http://192.168.0.100/restapi/system/notifications/events/'+_event+'/parameters/'+str(_event_parameter_index)+'/fixed_value/',auth=auth,headers=headers).json())
⇒
{}
Sample curl
read command (note that :event
and :event_parameter_index
are URL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/system/notifications/events/:event/parameters/:event_parameter_index/fixed_value/"
⇒
[]
object | system/notifications/events/S/ |
Event template |
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
message_template | Message template |
severity | Severity |
parameters | Event parameters |
Sample uom
library read command (note that _event
is a variable):
print(uom.dump(uom.system.notifications.events[_event]))
⇒
{message_template={"reboot initiated"},parameters={},severity=6}
Sample requests
read command (note that _event
is a variable):
print(requests.get('http://192.168.0.100/restapi/system/notifications/events/'+_event+'/',auth=auth,headers=headers).json())
⇒
{'severity': 6, 'message_template': ['backup restore initiated (', 0, ')'], 'parameters': [{'has_fixed_value': False, 'id': 'filename'}]}
array | system/notifications/events/S/message_template/ |
Template for human-readable message generation |
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Message template element elements.
Creating elements in this collection is not supported.
Sample JS request
read command (note that _event
is a variable):
request.get({url:"system/notifications/events/"+_event+"/message_template/"},function(error,response,body) {console.log(body)});
⇒
["backup restore initiated (",0,")"]
Sample curl
read command (note that :event
is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/system/notifications/events/:event/message_template/"
⇒
["upload ",0," deleted prematurely due to memory pressure"]
sum (variant) | system/notifications/events/S/message_template/N/ |
Element of human-readable message template |
Retrieving the value is denied if not administrative user
This sum is a part of a composite value which is modified as a whole.
This sum does not support direct modification.
This sum can assume the following values:
string | String | Fixed string | |
number | Parameter | Index of message parameter to insert | event parameters[the value] |
Sample requests
read command (note that _event
and _message_template_element_index
are variables):
print(requests.get('http://192.168.0.100/restapi/system/notifications/events/'+_event+'/message_template/'+str(_message_template_element_index)+'/',auth=auth,headers=headers).json())
⇒
0
Sample curl
read command (note that :event
and :message_template_element_index
are URL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/system/notifications/events/:event/message_template/:message_template_element_index/"
⇒
"reboot initiated"
sum (enumerated number) | system/notifications/events/S/severity/ |
Severity rating assigned to the event |
Retrieving the value is denied if not administrative user
This sum is a part of a composite value which is modified as a whole.
This sum does not support direct modification.
This sum can assume the following values:
constant 1 | Emergency | Treat the event as an emergency | |
constant 2 | Alert | Treat the event as an alert | |
constant 3 | Critical | Treat the event as critical | |
constant 4 | Error | Treat the event as an error | |
constant 5 | Warning | Treat the event as a warning | |
constant 6 | Notice | Treat the event as a notice | |
constant 7 | Informational | Treat the event as informational | |
constant 8 | Debug | Treat the event as debugging-related |
Sample curl
read command (note that :event
is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/system/notifications/events/:event/severity/"
⇒
4
Sample requests
read command (note that _event
is a variable):
print(requests.get('http://192.168.0.100/restapi/system/notifications/events/'+_event+'/severity/',auth=auth,headers=headers).json())
⇒
6
array | system/notifications/events/S/parameters/ |
Additional data associated with the event |
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Event parameter elements.
Creating elements in this collection is not supported.
Sample uom
library read command (note that _event
is a variable):
print(uom.dump(uom.system.notifications.events[_event].parameters))
⇒
{{has_fixed_value=false,id="filename"}}
Sample JS request
read command (note that _event
is a variable):
request.get({url:"system/notifications/events/"+_event+"/parameters/"},function(error,response,body) {console.log(body)});
⇒
[{"has_fixed_value":false,"id":"filename"}]
See also Event parameters: Event parameter