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 CLI read command:

uom get system

⇒

...

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/"

Browse more samples

Time

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 requests read command:

print(requests.get('http://192.168.0.100/restapi/system/time/',auth=auth,headers=headers).json())

⇒

1684917938.81

Sample uom library write command:

uom.system.time=1776293350.06

Browse more samples

Uptime

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 JS request read command:

request.get({url:"system/uptime/"},function(error,response,body) {console.log(body)});

⇒

141518918.44

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/system/uptime/',auth=auth,headers=headers).json())

⇒

150862293.35

Browse more samples

Uploads

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 uom library read command:

print(uom.dump(uom.system.uploads))

⇒

{["/tmp/uploads/.tmp-upload5M7ZEI"]=90.31}

Sample JS request read command:

request.get({url:"system/uploads/"},function(error,response,body) {console.log(body)});

⇒

{"/tmp/uploads/.tmp-uploadyRz2u6":39.74,"/tmp/uploads/.tmp-uploadGVgb2y":26.89,"/tmp/uploads/.tmp-upload9wpgN6":11.74,"/tmp/uploads/.tmp-upload8jgOdL":96.06,"/tmp/uploads/.tmp-uploada2ZXcg":68.41}

Browse more samples

Expiration time

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/"

⇒

78.93

Sample curl write command (note that :expiration_time 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 "20.78" "http://192.168.0.100/restapi/system/uploads/:expiration_time/"

Browse more samples

Upload file

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:

Content: string
Expiration: number

The call returns the following results:

Filename: string

Sample uom library invocation:

print(uom.dump(uom.system.upload_file("97bf485392ed12b5f685f958e320a376572c6a9b8fd52d226fb57a8befee7856e3834f85d8d2b5eb738f01660a8f4c0f3a0a13a37049322d246bd0ac4f876643a9eaf2a34e631152194750a0bbdc99db40778d7151ad9e0eb78fd087f93b7dd090d5dc5eebd6e77f67dddad8f76d5803159d21895923e80e58c460ca9f35f7e2afe23152438df3d075f79201000d1515439baa36133e2b5efa13c9df81541108ae8ddcc74328ad44d3021cedd8168ce7dc181f2a6c7a88f02b4d64fabcb673b19058f2ce2a6a44572e01",32)))

⇒

"/tmp/uploads/.tmp-uploadlIRErr"

Sample CLI invocation:

uom invoke "system/upload_file" "\"8a1057cf7820c2215417f21b895d468f7acc0c8563ff994b90ce44b3f06a9db0681918c4427400cc2df5b3ef5d899a3210fbde2b5b8ebabaae150518dcec9c6f9bebbb02894b3741ada7ef1ffca558f1d2f93bdc4c8aae3bdeeae96e036130759cfb00f2d19a0d1c107e4c4c9daa8bf12142d5602f30496a6c5af255257c0ca15a8f24442328fb79ad5db7cc8e282f73881a1152d98a8dc8d7944750cf313423fe\"" "99"

⇒

"/tmp/uploads/.tmp-uploadDx4xLH"

Browse more samples

Content

string	system/upload_file/arguments: 1/
File content

The value contains application/octet-stream data.

This string does not correspond to an actual resource.

Expiration

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.

Filename

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.

Remove uploaded file

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:

Filename: string

The call returns the following results:

Empty result: null

Sample CLI invocation:

uom invoke "system/remove_uploaded_file" "\"/tmp/uploads/.tmp-uploadWW378A\""

⇒

null

Sample JS request invocation:

request.post({url:"system/remove_uploaded_file/",body:["/tmp/uploads/.tmp-uploadmrRaYM"]});

⇒

null

Browse more samples

Filename

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.

Empty result

constant null	system/remove_uploaded_file/results: 1/
No additional information available

This constant does not correspond to an actual resource.

Verify upgrade image

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:

Filename: string

The call returns the following results:

System upgrade verification status: (Succeeded or Failed,string)

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-uploadgjtrl0\"]" "http://192.168.0.100/restapi/system/verify_upgrade/"

⇒

[false,"verify_upgrade failed"]

Sample CLI invocation:

uom invoke "system/verify_upgrade" "\"/tmp/uploads/.tmp-uploadyrQA9c\""

⇒

[false,"verify_upgrade failed"]

Browse more samples

Filename

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.

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

Status

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)

Message

string	system/verify_upgrade/results: 1/2/
Call status message

This string does not correspond to an actual resource.

Upgrade from file

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:

Filename: string

The call returns the following results:

System upgrade status: (Succeeded or Failed,string)

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-uploadZrBVKF\"]" "http://192.168.0.100/restapi/system/upgrade/"

⇒

[false,"upgrade failed"]

Sample JS request invocation:

request.post({url:"system/upgrade/",body:["/tmp/uploads/.tmp-uploadOsrUGp"]});

⇒

[true,"upgrade succeeded"]

Browse more samples

Filename

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.

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

Status

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)

Message

string	system/upgrade/results: 1/2/
Call status message

This string does not correspond to an actual resource.

Preserve user-installed packages on upgrade

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 JS request read command:

request.get({url:"system/preserve_packages/"},function(error,response,body) {console.log(body)});

⇒

[]

Sample CLI write command:

uom set "system/preserve_packages" "[]"

Browse more samples

Apply maintenance file

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:

Filename: string
Ask for confirmation: Enabled or Disabled

The call returns the following results:

Maintenance status: (Succeeded or Failed,string)

Sample JS request invocation:

request.post({url:"system/apply_maintenance_file/",body:["/tmp/uploads/.tmp-uploadVHedhV",false]});

⇒

[true,"maintenance succeeded"]

Sample requests invocation:

print(requests.post('http://192.168.0.100/restapi/system/apply_maintenance_file/',auth=auth,headers=headers,json=['/tmp/uploads/.tmp-upload7tcmXy', True]).json())

⇒

[True, 'maintenance succeeded']

Browse more samples

Filename

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.

Ask for confirmation

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

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

Status

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)

Message

string	system/apply_maintenance_file/results: 1/2/
Call status message

This string does not correspond to an actual resource.

Apply maintenance code

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:

Code: string
Ask for confirmation: Enabled or Disabled

The call returns the following results:

Maintenance status: (Succeeded or Failed,string)

Sample uom library invocation:

print(uom.dump(uom.system.apply_maintenance_code("cVuFXv J?J=>\"+'W''Xw9d:cQ%B_km$~",true)))

⇒

{true,"maintenance succeeded"}

Sample JS request invocation:

request.post({url:"system/apply_maintenance_code/",body:["{B&?U2MVw\"*O/m#C/",true]});

⇒

[true,"maintenance succeeded"]

Browse more samples

Code

string	system/apply_maintenance_code/arguments: 1/
Maintenance code

This string does not correspond to an actual resource.

Ask for confirmation

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

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

Status

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)

Message

string	system/apply_maintenance_code/results: 1/2/
Call status message

This string does not correspond to an actual resource.

Enumerate configuration

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:

Elements: map of "object "Element""

Sample CLI invocation:

uom invoke "system/enumerate_configuration"

⇒

{"/etc/config/nmVEu4Fr4d":{"name":"SNMP configuration","modified":true,"mode":"dr-xrw-r-x","orig_mode":"dr-xrw-r-x","private":false},"/etc/vxAh":{"name":"HTTP configuration","modified":true,"mode":"-rw----r--","orig_mode":null,"private":false}}

Sample JS request invocation:

request.post({url:"system/enumerate_configuration/",body:[]});

⇒

[]

Browse more samples

Elements

map	system/enumerate_configuration/results: 1/
Currently known configuration elements

This map does not correspond to an actual resource.

This map contains Element elements.

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

Name

string	system/enumerate_configuration/results: 1/S/name/
Human-readable element name

This string does not correspond to an actual resource.

Element mode, if any

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

Original element mode, if any

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

Modification flag

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

Sensitive information flag

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

Create backup of configuration

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:

Elements: map of "true"

The call returns the following results:

Content type: string
Content: string

Sample requests invocation:

print(requests.post('http://192.168.0.100/restapi/system/create_backup/',auth=auth,headers=headers,json=[{'/storage/AE36gjTW': True, '/src/tX1v': True, '/etc/sI4yCBEuvez': True, '/etc/zJuOAtl': True, '/src/u5QWI': True, '/etc/tVK7EgP': True, '/src/CknZZxMEK': True, '/etc/config/wQ_Z1': True, '/storage/K8-zW3Fm': True}]).json())

⇒

Sample uom library invocation:

print(uom.dump(uom.system.create_backup({["/etc/HmS7Yu"]=true,["/etc/UFJdTTq7P5d"]=true,["/etc/config/eyvj6q"]=true,["/src/XjpYX0Xf"]=true})))

⇒

Browse more samples

Content type

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.

Content

string	system/create_backup/results: 2/
File content

The value contains application/octet-stream data.

This string does not correspond to an actual resource.

Create backup of configuration: Elements

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.

Chosen

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.

Enumerate configuration from backup

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:

Filename: string
File filter: All, None, Resolved, Unresolved, Next unresolved or array of "string"
Return options: Enabled or Disabled

The call returns the following results:

Enumeration result: map of "object "Element"" or Enumeration failure

Sample CLI invocation:

uom invoke "system/enumerate_backup" "\"/tmp/uploads/.tmp-uploadVGUnEg\"" "\"unresolved\"" "true"

⇒

{"/etc/SXnSMrxy":{"resolution":"their file ","name":"AutoPing configuration","group_name":null}}

Sample uom library invocation:

print(uom.dump(uom.system.enumerate_backup("/tmp/uploads/.tmp-uploads3X14K",false,false)))

⇒

"Something went wrong"

Browse more samples

Filename

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.

File filter

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

Return options

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

Enumeration result

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

File filter: Selected

(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.

Filename

string	system/enumerate_backup/arguments: 2/N/
Return information on this file

This string does not correspond to an actual resource.

Resolution option(s): Options

(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.

Option

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

Presence flag

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

Element mode, if any

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

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.

Badness

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.

Enumeration result: Elements

(possibly) map	system/enumerate_backup/results: 1/
Backup configuration elements

This map does not correspond to an actual resource.

This map contains Element elements.

Element

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)

Name, if any

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

Group name, if any

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

Resolution option(s)

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

Known backup resolution 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 curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/system/known_backup_resolution_options/"

⇒

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/system/known_backup_resolution_options/',auth=auth,headers=headers).json())

⇒

Browse more samples

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 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 "{\"result\":\"merged\",\"action\":\"apply our changes to backup file\",\"label\":\"backup file with current changes\"}" "http://192.168.0.100/restapi/system/known_backup_resolution_options/:resolution_option/"

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"}

Browse more samples

Action

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 "\"apply changes in the backup to our original file\"" "http://192.168.0.100/restapi/system/known_backup_resolution_options/:resolution_option/action/"

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+'/action/',auth=auth,headers=headers,json='apply changes in the backup to our current file')

Browse more samples

Label

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 uom library write command (note that _resolution_option is a variable):

uom.system.known_backup_resolution_options[_resolution_option].label="current file"

Sample CLI read command (note that resolution_option is a variable):

uom get "system/known_backup_resolution_options/${resolution_option}/label"

⇒

"original file with backup changes"

Browse more samples

Result

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 uom library write command (note that _resolution_option is a variable):

uom.system.known_backup_resolution_options[_resolution_option].result="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'

Browse more samples

Resolve backup item

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:

Filename: string
Item, if any: All unresolved items or Item
Resolution option: string
Resolution label, if any: Default label or Resolution label

The call returns the following results:

Backup item resolution status: (Succeeded or Failed,string)

Sample JS request invocation:

request.post({url:"system/resolve_backup_item/",body:["/tmp/uploads/.tmp-uploadaZdFgh",null,"their_file_and_our_diff","their orig "]});

⇒

[true,"resolve succeeded"]

Sample requests invocation:

print(requests.post('http://192.168.0.100/restapi/system/resolve_backup_item/',auth=auth,headers=headers,json=['/tmp/uploads/.tmp-uploadZ0rPnH', '/src/GrpwHqjZQTno', 'our_file_and_their_diff', 'our diff and their diff']).json())

⇒

[True, 'resolve succeeded']

Browse more samples

Filename

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.

Item, if any

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

Resolution option

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.

Resolution label, if any

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

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

Status

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)

Message

string	system/resolve_backup_item/results: 1/2/
Call status message

This string does not correspond to an actual resource.

Resolve backup item with custom content

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:

Filename: string
Item: string
Element mode, if any: Absent, File, Directory or Symlink
Data: string
Resolution label: string

The call returns the following results:

Backup item resolution status: (Succeeded or Failed,string)

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-uploadYTwQVY\",\"/etc/a1gnu\",\"dr----x-w-\",\"84b84899d53b79b1d42c5bf82340e4dbac7f4876731f94afe4cb01cf15c40de8fbfe48485b84eafb1cecd7bdee60b5265b6f2ff3e34a3c5862de70247802401164ff3a986bfa30d4d60fcb0e2053a7a15eb34ef1d9194dd60cc6576cff5a9fd91739b0c9acf8126e9852528e44b877210bfd2e5ea8668db1cc99fa2077cb8396300b2f880534e813924a83330be19acab1f3726ec838e9f248a4df975503df771081f81bd65086fbe9f40ad18732f2ecf915017383b9f214486d53ad841bb032702d6eecbda6012f995e113cc9e5cbd204c548c3d36bb3f252288c90cb80cfaa96fa74d093d2c9d9b404d1845aa5bfe5523266826bfe09d7d53738c267e2\",\"their orig and our file\"]" "http://192.168.0.100/restapi/system/resolve_backup_item_with_content/"

⇒

[false,"resolve failed"]

Sample requests invocation:

print(requests.post('http://192.168.0.100/restapi/system/resolve_backup_item_with_content/',auth=auth,headers=headers,json=['/tmp/uploads/.tmp-uploadY0HmHQ', '/storage/eaHqhx4', 'drwx-wxr-x', '166732624b2d97714d9bd90c23bfceae589a40858630315d91fbfda9969a63d27296efe7224411c0e0fc5cad51305a3fc1a79a12602a359db0c7eb2d2590ef53b334bdaf452954777f4d3d80a33b37eb79f003f42cda8dbc26358f2d72b84f4098ce2b456f2a8001697f9a549466ca0d9003cdd80302fd68ef2661811cdf5fd58a83f935e78fd8d0c969ae6cb9e92484e50af02926cea2e269e56d07ba1fe5ef96918721bfbd9d4d163371c817d1c9e09dbd376a0940560ed9507d985deb09158ac5690065710847e382b8ee07781115ca76456351b3c40d0d3f6293070a7a9dfe118f68ef99a1c26853129d0521e042258eaccf7a687e8e260ea9f2d476d871', 'our diff ']).json())

⇒

[False, 'resolve failed']

Browse more samples

Filename

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.

Item

string	system/resolve_backup_item_with_content/arguments: 2/
Backup item

This string does not correspond to an actual resource.

Element mode, if any

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

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.

Resolution label

string	system/resolve_backup_item_with_content/arguments: 5/
Backup item resolution label for reference

This string does not correspond to an actual resource.

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

Status

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)

Message

string	system/resolve_backup_item_with_content/results: 1/2/
Call status message

This string does not correspond to an actual resource.

Perform restoration of configuration from backup

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:

Filename: string

The call returns the following results:

Backup restore status: (Succeeded or Failed,string)

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-uploadNE6coa\"]" "http://192.168.0.100/restapi/system/restore_backup/"

⇒

[false,"restore failed"]

Sample requests invocation:

print(requests.post('http://192.168.0.100/restapi/system/restore_backup/',auth=auth,headers=headers,json=['/tmp/uploads/.tmp-uploadE5591h']).json())

⇒

[False, 'restore failed']

Browse more samples

Filename

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.

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

Status

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)

Message

string	system/restore_backup/results: 1/2/
Call status message

This string does not correspond to an actual resource.

Reboot

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:

Empty result: null

Sample requests invocation:

print(requests.post('http://192.168.0.100/restapi/system/reboot/',auth=auth,headers=headers,json={}).json())

⇒

None

Sample CLI invocation:

uom invoke "system/reboot"

⇒

null

Browse more samples

Empty result

constant null	system/reboot/results: 1/
No additional information available

This constant does not correspond to an actual resource.

Notifications

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 curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/system/notifications/"

⇒

Sample JS request read command:

request.get({url:"system/notifications/"},function(error,response,body) {console.log(body)});

⇒

Browse more samples

Events

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 curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/system/notifications/events/"

⇒

Sample uom library read command:

print(uom.dump(uom.system.notifications.events))

⇒

Browse more samples

Notifications: Parameter kinds

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

Event parameters: Event parameter

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 uom library read command (note that _event and _event_parameter_index are variables):

print(uom.dump(uom.system.notifications.events[_event].parameters[_event_parameter_index]))

⇒

{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/"

Browse more samples

Identifier

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 CLI read command (note that event and event_parameter_index are variables):

uom get "system/notifications/events/${event}/parameters/${event_parameter_index}/id"

⇒

"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'

Browse more samples

Fixed value flag

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 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

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()+"/has_fixed_value/"},function(error,response,body) {console.log(body)});

⇒

false

Browse more samples

Fixed value

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 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/"

⇒

[]

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())

⇒

{}

Browse more samples

Events: Event

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 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': ['reboot initiated'], 'parameters': {}}

Sample curl write command (note that :event 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 "{\"severity\":6,\"message_template\":[\"backup restore initiated (\",0,\")\"],\"parameters\":[{\"has_fixed_value\":false,\"id\":\"filename\"}]}" "http://192.168.0.100/restapi/system/notifications/events/:event/"

Browse more samples

Message template

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 requests read command (note that _event is a variable):

print(requests.get('http://192.168.0.100/restapi/system/notifications/events/'+_event+'/message_template/',auth=auth,headers=headers).json())

⇒

['upload ', 0, ' deleted prematurely due to memory pressure']

Sample CLI read command (note that event is a variable):

uom get "system/notifications/events/${event}/message_template"

⇒

["upload ",0," deleted prematurely due to memory pressure"]

Browse more samples

Message template element

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 CLI read command (note that event and message_template_element_index are variables):

uom get "system/notifications/events/${event}/message_template/${message_template_element_index}"

⇒

"backup restore initiated ("

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/"

⇒

"system upgrade initiated ("

Browse more samples

Severity

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 JS request read command (note that _event is a variable):

request.get({url:"system/notifications/events/"+_event+"/severity/"},function(error,response,body) {console.log(body)});

⇒

Sample CLI read command (note that event is a variable):

uom get "system/notifications/events/${event}/severity"

⇒

Browse more samples

Event parameters

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 CLI read command (note that event is a variable):

uom get "system/notifications/events/${event}/parameters"

⇒

[{"has_fixed_value":false,"id":"filename"}]

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/parameters/"

⇒

[{"has_fixed_value":false,"id":"filename"}]

Browse more samples