Comprehensive API documentation for OpenMediaVault 8.x RPC functions.
Total: 217 methods across 24 modules
- Apt
- CertificateMgmt
- Config
- Cron
- DiskMgmt
- Exec
- FolderBrowser
- FsTab
- Iptables
- LogFile
- Network
- Nfs
- Notification
- OMVRpcServiceFileSystemMgmt
- Quota
- RRD
- Rsync
- Smart
- Smb
- Ssh
- Syslog
- System
- UserMgmt
- WebGui
File: functions/apt.json
| # | Method | Description |
|---|---|---|
| 1 | getSoftwareSettings |
Get software settings. |
| 2 | setSoftwareSettings |
Set software settings. |
| 3 | getUpdatesSettings |
Get updates settings. |
| 4 | setUpdatesSettings |
Set updates settings. |
| 5 | enumerateUpgraded |
Enumerate all packages that are available to be upgraded |
| 6 | getUpgradedList |
Get a list of all packages that are to be upgraded |
| 7 | install |
Install the given packages. \em packages An array of package names to upgrade. |
| 8 | upgrade |
Packages currently installed with new versions available are retrieved and up... |
| 9 | update |
Update APT cache |
| 10 | upload |
Upload a package to the local package archive. \em filename The original name... |
| 11 | getChangeLog |
Get the changelog of an Debian package |
File: functions/certificatemgmt.json
| # | Method | Description |
|---|---|---|
| 1 | getList |
Get list of SSL certificate configuration objects |
| 2 | get |
Get a SSL certificate configuration object. \em uuid The UUID of the configur... |
| 3 | set |
Set (add/update) a SSL certificate configuration object |
| 4 | delete |
Delete a SSL certificate config object. \em uuid The UUID of the configuratio... |
| 5 | getDetail |
Get detail about a SSL certificate. \em uuid The UUID of the configuration ob... |
| 6 | create |
Create a SSL certificate |
| 7 | getSshList |
Get list of SSH certificate configuration objects |
| 8 | createSsh |
Create a SSH certificate. \em comment The comment |
| 9 | getSsh |
Get a SSH certificate configuration object |
| 10 | setSsh |
Set (add/update) a SSH certificate configuration object |
| 11 | deleteSsh |
Delete a SSH certificate config object. \em uuid The UUID of the configuratio... |
| 12 | copySshId |
Copy the public key of a SSH certificate to a remote machine |
File: functions/config.json
| # | Method | Description |
|---|---|---|
| 1 | isDirty |
Check if the configuration has been modified |
| 2 | applyChanges |
Apply the configuration changes |
| 3 | applyChangesBg |
Apply the configuration changes in a background process. |
| 4 | revertChanges |
Revert the configuration changes. \em filename The revision file. Set to empt... |
| 5 | revertChangesBg |
Revert the configuration changes in a background process. |
| 6 | getlist |
Get list of configuration objects |
| 7 | get |
Get a configuration object |
| 8 | set |
Set a configuration object. \em id The data model identifier, e.g. 'conf.serv... |
| 9 | delete |
Delete a configuration object |
File: functions/cron.json
| # | Method | Description |
|---|---|---|
| 1 | getList |
Get the cron jobs of the requested type |
| 2 | get |
Get a cron job configuration object. \em uuid The UUID of the configuration o... |
| 3 | set |
Set (add/update) a cron job configuration object. |
| 4 | delete |
Delete a cron job configuration object. \em uuid The UUID of the configuratio... |
| 5 | execute |
Execute a cron job. \em uuid The UUID of the configuration object. |
File: functions/diskmgmt.json
| # | Method | Description |
|---|---|---|
| 1 | enumerateDevices |
Enumerate all disk devices on the system |
| 2 | getList |
Enumerate all disk devices on the system |
| 3 | getListBg |
Execute the getList RPC as background process. |
| 4 | getHdParm |
Get a hard disk parameters config object. \em uuid The UUID of the configurat... |
| 5 | setHdParm |
Set (add/update) a hard disk parameters config object. |
| 6 | wipe |
Wipe the given device. \em devicefile The device file to wipe, e.g. /dev/sdb.... |
| 7 | rescan |
Rescan SCSI bus. |
File: functions/exec.json
| # | Method | Description |
|---|---|---|
| 1 | stop |
Stop the given background process. \em filename The name of the background pr... |
| 2 | getOutput |
Get the output of the given background process |
| 3 | isRunning |
Check if the given background process is still running |
| 4 | enumerate |
Determine all running background processes |
| 5 | attach |
Attach to the specified background process. \em filename The name of the back... |
File: functions/folderbrowser.json
| # | Method | Description |
|---|---|---|
| 1 | get |
List the contents of the given directory |
File: functions/fstab.json
| # | Method | Description |
|---|---|---|
| 1 | enumerateEntries |
Enumerate all fstab mount point entries. entry. |
| 2 | get |
Get a mount point configuration object. \em uuid The UUID of the configuratio... |
| 3 | set |
Set a mount point configuration object |
| 4 | delete |
Delete a mount point configuration object. The mount point in the filesystem ... |
| 5 | getByFsName |
Get a mount point configuration object by the given file system name, which m... |
| 6 | getByDir |
Get a mount point configuration object by the given mount point. \em dir The ... |
File: functions/iptables.json
| # | Method | Description |
|---|---|---|
| 1 | getRulesByFamily |
Helper function to get all rules for the given family. |
| 2 | getRules |
Get all IPv4 iptables rules. |
| 3 | getRules6 |
Get all IPv6 iptables rules. |
| 4 | setRulesByFamily |
Set multiple iptables rules at one time. |
| 5 | setRules |
Set multiple IPv4 iptables rules at one time. |
| 6 | setRules6 |
Set multiple IPv6 iptables rules at one time. |
| 7 | getRule |
Get an iptables rule configuration object. \em uuid The UUID of the configura... |
| 8 | setRule |
Set an iptables rule configuration object. |
| 9 | deleteRule |
Delete an iptables rule configuration object. \em uuid The UUID of the config... |
File: functions/logfile.json
| # | Method | Description |
|---|---|---|
| 1 | getList |
Helper method to parse a logfile |
| 2 | clear |
Clear a syslog file. \em id The identifier of the registered log file type. |
| 3 | getContent |
Get the content of a log file |
File: functions/network.json
| # | Method | Description |
|---|---|---|
| 1 | getIfaceInfo |
Helper function to get details of the given network interface device |
| 2 | setInterfaceConfig |
Helper function to store the interface configuration object. attributes. |
| 3 | getGeneralSettings |
Get general network settings. |
| 4 | setGeneralSettings |
Set general network settings. |
| 5 | enumerateDevices |
Enumerate all network interface devices on the system |
| 6 | enumerateDevicesList |
Enumerate all network interface devices on the system, except loopback |
| 7 | enumerateConfiguredDevices |
Get all configured network interfaces devices. |
| 8 | identify |
Initiate adapter-specific action intended to enable an operator to easily ide... |
| 9 | getInformation |
Get runtime information about the given network interface. \em devicename The... |
| 10 | getInterfaceList |
Get all network interface configuration objects |
| 11 | getInterface |
Get a network interface configuration object. \em uuid The UUID of the config... |
| 12 | deleteInterface |
Delete a network interface configuration object. \em uuid The UUID of the con... |
| 13 | getEthernetCandidates |
Get list of devices that can be used to create an ethernet connection. |
| 14 | getEthernetIface |
Get a ethernet network interface configuration object. \em uuid The UUID of t... |
| 15 | setEthernetIface |
Set (add/update) a ethernet network interface configuration object. |
| 16 | enumerateBondSlaves |
Enumerate all interfaces from a bonded interface object |
| 17 | getBondIface |
Get a bonded interface configuration object. \em uuid The UUID of the configu... |
| 18 | setBondIface |
Set (add/update) a bond interface config object. |
| 19 | getVlanCandidates |
Get list of devices that can be used to create a VLAN connection. |
| 20 | getVlanIface |
Get a VLAN network interface configuration object. \em uuid The UUID of the c... |
| 21 | setVlanIface |
Set (add/update) a VLAN network interface configuration object. |
| 22 | getWirelessCandidates |
Get list of devices that can be used to create a Wi-Fi connection. |
| 23 | getWirelessIface |
Get a wireless network interface configuration object. \em uuid The UUID of t... |
| 24 | setWirelessIface |
Set (add/update) a wireless network interface configuration object. |
| 25 | enumerateBridgeSlaves |
Enumerate all interfaces from a bridge interface object |
| 26 | getBridgeIface |
Get a bridge interface configuration object. \em uuid The UUID of the configu... |
| 27 | setBridgeIface |
Set (add/update) a bridge interface config object. |
| 28 | getProxy |
Get the proxy settings. |
| 29 | setProxy |
Set the proxy settings. |
File: functions/nfs.json
| # | Method | Description |
|---|---|---|
| 1 | getSettings |
Get the settings. |
| 2 | setSettings |
Set the settings. |
| 3 | getShareList |
Get list of share configuration objects |
| 4 | getShare |
Get a share configuration object. \em uuid The UUID of the configuration object. |
| 5 | setShare |
Set a share configuration object. |
| 6 | deleteShare |
Delete a share config object. \em uuid The UUID of the configuration object. |
| 7 | getStats |
Get statistics. |
File: functions/notification.json
| # | Method | Description |
|---|---|---|
| 1 | getNotificationConfig |
Get the notification configuration of all registered modules. |
| 2 | getList |
Get the notification configuration objects. |
| 3 | setList |
Set a bunch of notification configuration objects. |
| 4 | get |
Get configuration object. |
| 5 | set |
Set configuration object. |
| 6 | isEnabled |
Checks whether a notification is enabled. \em id The notification identifier. |
| 7 | get |
Get configuration object. |
| 8 | set |
Set configuration object. |
| 9 | sendTestEmail |
Send a test email. The email notification service must already be configured. |
File: functions/omvrpcservicefilesystemmgmt.json
| # | Method | Description |
|---|---|---|
| 1 | getFsInfo |
Helper function to get information about the given file system. |
| 2 | getMountPointConfigObject |
Helper function to get the mount point configuration object. |
| 3 | enumerateFilesystems |
Enumerate all file systems that have been detected, except the file system co... |
| 4 | enumerateMountedFilesystems |
Enumerate all file systems that have a mount point configuration object, exce... |
| 5 | getMountCandidates |
Get the file systems that can be mounted |
| 6 | getList |
Get the list of configured file systems |
| 7 | getListBg |
Execute the getList RPC as background process. |
| 8 | getCandidates |
Get list of devices that can be used to create a file system on. devicefile, ... |
| 9 | getCandidatesBg |
Execute the getCandidates RPC as background process. |
| 10 | create |
Create a file system on the given storage device |
| 11 | createBtrfs |
Create a Btrfs volume. |
| 12 | grow |
Grow a file system. \em id The UUID or block special device of the file syste... |
| 13 | setMountPoint |
Set a mount point configuration object |
| 14 | umountByFsName |
Unmount a file system by the given file system name, which may be an UUID or ... |
| 15 | umountByDir |
Unmount a file system by the given mount point |
| 16 | hasFilesystem |
Check if the given device containes a file system that is registered. \em dev... |
| 17 | getDetails |
Get details about the filesystem, e.g. the health status. \em devicefile The ... |
File: functions/quota.json
| # | Method | Description |
|---|---|---|
| 1 | get |
Get the quota for the given filesystem. \em uuid The UUID of the filesystem. |
| 2 | set |
Set the quota for the given filesystem. \em uuid The UUID of the filesystem. ... |
| 3 | getByTypeName |
Get the quota for the given filesystem and type/name |
| 4 | setByTypeName |
Set the quota for the given filesystem and type/name |
| 5 | delete |
Delete a filesystem quota configuration object. \em uuid The UUID of the conf... |
File: functions/rrd.json
| # | Method | Description |
|---|---|---|
| 1 | generate |
Generate the RRD graphs. |
| 2 | getGraph |
Get graph |
File: functions/rsync.json
| # | Method | Description |
|---|---|---|
| 1 | getList |
Get list of rsync job configuration objects |
| 2 | get |
Get a rsync job configuration object. \em uuid The UUID of the configuration ... |
| 3 | set |
Set a rsync job configuration object. |
| 4 | delete |
Delete a rsync job configuration object. \em uuid The UUID of the configurati... |
| 5 | execute |
Execute a rsync job. \em uuid The UUID of the cron job to execute. |
File: functions/smart.json
| # | Method | Description |
|---|---|---|
| 1 | enumerateDevices |
Enumerate all devices supporting S.M.A.R.T |
| 2 | enumerateMonitoredDevices |
Get list of devices that are monitored |
| 3 | getList |
Get all devices supporting S.M.A.R.T |
| 4 | getListBg |
Execute the getList RPC as background process. |
| 5 | getSettings |
Get the settings. |
| 6 | setSettings |
Set the settings. |
| 7 | getDeviceSettings |
Get the device settings. \em devicefile The device file, e.g. \li /dev/sdb \l... |
| 8 | setDeviceSettings |
Set the device settings |
| 9 | getExtendedInformation |
Get the extended S.M.A.R.T. information about the given device. \em devicefil... |
| 10 | getAttributes |
Get 'S.M.A.R.T. Attributes Data Structure' about the given device. \em device... |
| 11 | getSelfTestLogs |
Get 'SMART Self-test log structure' about the given device. \em devicefile Th... |
| 12 | getInformation |
Get all S.M.A.R.T. identity information for the given device. \em devicefile ... |
| 13 | getScheduleList |
Get list of schedule configuration objects |
| 14 | getScheduledTest |
Get a scheduled test configuration object. \em uuid The UUID of the configura... |
| 15 | setScheduledTest |
Set a scheduled test config object. |
| 16 | deleteScheduledTest |
Delete a scheduled test configuration object. \em uuid The UUID of the config... |
| 17 | executeScheduledTest |
Execute a scheduled test. \em uuid The UUID of the configuration object. |
File: functions/smb.json
| # | Method | Description |
|---|---|---|
| 1 | getSettings |
Get the configuration settings. |
| 2 | setSettings |
Set the configuration settings. |
| 3 | getShareList |
Get list of share configuration objects |
| 4 | getShare |
Get a share configuration object. \em uuid The UUID of the configuration object. |
| 5 | setShare |
Set a share configuration object. |
| 6 | deleteShare |
Delete a share configuration object. \em uuid The UUID of the configuration o... |
| 7 | emptyRecycleBin |
Empty the recycle bin of the given shared folder. \em uuid The UUID of the co... |
| 8 | getStats |
Get statistics. |
File: functions/ssh.json
| # | Method | Description |
|---|---|---|
| 1 | get |
Get the configuration settings. |
| 2 | set |
Set the configuration settings. |
| 3 | getStats |
Get statistics, e.g. who's online. |
File: functions/syslog.json
| # | Method | Description |
|---|---|---|
| 1 | getSettings |
Get the syslog settings. |
| 2 | setSettings |
Set the syslog settings. |
File: functions/system.json
| # | Method | Description |
|---|---|---|
| 1 | noop |
This function can be used to check if the communication between WebGUI and se... |
| 2 | getTopInfo |
Get the list of running processes and a system summary information as well |
| 3 | getShells |
Get a list of available shells. |
| 4 | reboot |
Reboot the system. \em delay The number of seconds to delay. |
| 5 | shutdown |
Shut down the system. \em delay The number of seconds to delay. |
| 6 | standby |
Put the machine in a sleep state |
| 7 | suspend |
Put the machine into suspend to RAM (STR) mode. If this state is not supporte... |
| 8 | hibernate |
Put the machine into suspend to disk (STD) mode. If this state is not support... |
| 9 | getTimeSettings |
Get system time settings. |
| 10 | setTimeSettings |
Set system time settings. |
| 11 | setDate |
Set the system date. \em timestamp The date to set as UNIX timestamp. |
| 12 | getTimeZoneList |
Get a list of time zones. |
| 13 | getInformation |
Get various system information. Note, all numbers that might be > 4GiB are re... |
| 14 | getDiagnosticReport |
Get the 'omv-sysinfo' diagnostic report. The method does not have any paramat... |
| 15 | getCpuStats |
Get CPU statistics. |
| 16 | getCpuGovernors |
Get a list of available CPU frequency governors. |
File: functions/usermgmt.json
| # | Method | Description |
|---|---|---|
| 1 | authUser |
Method authUser |
| 2 | enumerateSystemUsers |
Get the list of system users. \em detail Specifies the detail level of the us... |
| 3 | enumerateUsers |
Get the list of non-system users. \em detail Specifies the detail level of th... |
| 4 | enumerateAllUsers |
Get the list of all users. \em detail Specifies the detail level of the user ... |
| 5 | enumerateSystemGroups |
Get the list of system groups. |
| 6 | enumerateGroups |
Get the list of non-system groups. |
| 7 | enumerateAllGroups |
Get the list of all groups. |
| 8 | getUserList |
Get list of users (except system users) |
| 9 | getUser |
Get an user configuration object. \em name The name of the user. |
| 10 | getUserByContext |
Get the user configuration from the current context user |
| 11 | setUser |
Set (add/update) a non-system user account |
| 12 | setUserByContext |
Set an user configuration object of the current context user |
| 13 | deleteUser |
Delete a user. \em name The name of the user to delete. |
| 14 | importUsers |
Import a list of users |
| 15 | getGroupList |
Get list of groups (except system groups) |
| 16 | getGroup |
Get a group. \em name The name of the group. |
| 17 | setGroup |
Set (add/update) a non-system group account |
| 18 | deleteGroup |
Delete a group. \em name The name of the group to delete. |
| 19 | importGroups |
Import a list of groups. \em csv The group values, e.g.: name;gid;comment grp... |
| 20 | getSettings |
Get user management settings. |
| 21 | setSettings |
Set user management settings. |
| 22 | setPasswordByContext |
Set the password of the current context user. \em password The new password. |
File: functions/webgui.json
| # | Method | Description |
|---|---|---|
| 1 | getSettings |
Get settings. |
| 2 | setSettings |
Set settings. |
| 3 | dismissWelcomeMessage |
Dismiss the welcome message which is displayed at the first log in. |
| 4 | getLocalStorageItems |
Get the local storage settings of the current context user. \em devicetype Th... |
| 5 | setLocalStorageItem |
Set the local storage settings of the current context user |
| 6 | clearLocalStorageItems |
Clear the local storage settings of the current context user. \em devicetype ... |
| 7 | getAutoLogoutSettings |
Get the auto-logout settings. |