Legrand / Raritan Xerus™ JSON-RPC API for Remote Access Devices like KX4-101, KX3G2

Loading...
Searching...
No Matches
AutoScan.idl
1#ifndef __RADM_AUTOSCAN_IDL__
2#define __RADM_AUTOSCAN_IDL__
3
4#include <UserEvent.idl>
5
6module radm {
7
8 interface AutoScan {
9 constant int ERR_INVALID_ARGUMENT = 1;
10
11 enumeration NfsStatus {
12 INACTIVE, ///< NFS share is inactive and not mounted
13 RESOLVING, ///< Resolving NFS server host name
14 MOUNTING, ///< Mounting NFS server share
15 MOUNTED, ///< Mounted NFS server share
16 SUSPENDED, ///< NFS share is suspended after being restarted after failure
17 FAILED ///< Connection to NFS share has failed
18 };
19
20 structure Settings {
21 boolean enabled; ///< Whether auto-scan is enabled
22 int scale; ///< Scaling of stored snapshots (in percent)
23 int interval; ///< Scan interval (in seconds)
24 string nfsServerHost; ///< Host name or IP address of NFS server to store to
25 string nfsDirectory; ///< Directory path on NFS server to store to
26 int maxStoredFiles; ///< Maximum number of stored files (0 for no limitation)
27 };
28
29 /**
30 * Get settings
31 *
32 * @return Settings
33 */
34 Settings getSettings();
35
36 /**
37 * Set settings
38 *
39 * @param settings New settings
40 *
41 * @return 0 on success
42 * @return 1 if any setting was invalid
43 */
44 int setSettings(in Settings settings);
45
46 /**
47 * Get NFS server status
48 *
49 * @return NFS server status
50 */
51 NfsStatus getNfsStatus();
52
53 /** Event: Settings have changed */
54 valueobject SettingsChangedEvent extends event.UserEvent {
55 Settings oldSettings; ///< Settings before change
56 Settings newSettings; ///< Settings after change
57 };
58
59 /** Event: NFS server status has changed */
60 valueobject NfsStatusChangedEvent extends idl.Event {
61 NfsStatus newStatus; ///< New status after change
62 string nfsServer; ///< NFS server host name
63 string failureMessage; ///< Failure message in case of FAILED state
64 };
65 };
66}
67
68#endif //__RADM_AUTOSCAN_IDL__
radm::AutoScan
Definition AutoScan.idl:8
radm::AutoScan::setSettings
int setSettings(in Settings settings)
Set settings.
radm::AutoScan::NfsStatus
NfsStatus
Definition AutoScan.idl:11
radm::AutoScan::MOUNTING
@ MOUNTING
Mounting NFS server share.
Definition AutoScan.idl:14
radm::AutoScan::SUSPENDED
@ SUSPENDED
NFS share is suspended after being restarted after failure.
Definition AutoScan.idl:16
radm::AutoScan::INACTIVE
@ INACTIVE
NFS share is inactive and not mounted.
Definition AutoScan.idl:12
radm::AutoScan::MOUNTED
@ MOUNTED
Mounted NFS server share.
Definition AutoScan.idl:15
radm::AutoScan::FAILED
@ FAILED
Connection to NFS share has failed.
Definition AutoScan.idl:17
radm::AutoScan::RESOLVING
@ RESOLVING
Resolving NFS server host name.
Definition AutoScan.idl:13
radm::AutoScan::getSettings
Settings getSettings()
Get settings.
radm::AutoScan::getNfsStatus
NfsStatus getNfsStatus()
Get NFS server status.
idl
Basic IDL definitions.
Definition Event.idl:10
radm
Radm Model.
Definition AccessPort.idl:8
idl::Event
Common base for all events.
Definition Event.idl:13
radm::AutoScan::NfsStatusChangedEvent
Event: NFS server status has changed.
Definition AutoScan.idl:60
radm::AutoScan::NfsStatusChangedEvent::failureMessage
string failureMessage
Failure message in case of FAILED state.
Definition AutoScan.idl:63
radm::AutoScan::NfsStatusChangedEvent::nfsServer
string nfsServer
NFS server host name.
Definition AutoScan.idl:62
radm::AutoScan::NfsStatusChangedEvent::newStatus
NfsStatus newStatus
New status after change.
Definition AutoScan.idl:61
radm::AutoScan::SettingsChangedEvent
Event: Settings have changed.
Definition AutoScan.idl:54
radm::AutoScan::SettingsChangedEvent::oldSettings
Settings oldSettings
Settings before change.
Definition AutoScan.idl:55
radm::AutoScan::SettingsChangedEvent::newSettings
Settings newSettings
Settings after change.
Definition AutoScan.idl:56
radm::AutoScan::Settings
Definition AutoScan.idl:20
radm::AutoScan::Settings::enabled
boolean enabled
Whether auto-scan is enabled.
Definition AutoScan.idl:21
radm::AutoScan::Settings::interval
int interval
Scan interval (in seconds)
Definition AutoScan.idl:23
radm::AutoScan::Settings::maxStoredFiles
int maxStoredFiles
Maximum number of stored files (0 for no limitation)
Definition AutoScan.idl:26
radm::AutoScan::Settings::nfsDirectory
string nfsDirectory
Directory path on NFS server to store to.
Definition AutoScan.idl:25
radm::AutoScan::Settings::scale
int scale
Scaling of stored snapshots (in percent)
Definition AutoScan.idl:22
radm::AutoScan::Settings::nfsServerHost
string nfsServerHost
Host name or IP address of NFS server to store to.
Definition AutoScan.idl:24