Raritan PX2/PX3 JSON-RPC API
|
6 #include <UserEvent.idl>
73 valueobject SettingsChangedEvent extends
event.UserEvent {
77 valueobject SavedEvent extends
event.UserEvent {
82 valueobject RestoredEvent extends
event.UserEvent {
89 constant
int SUCCESS = 0;
90 constant
int ERR_FILTER_NAME_UNKNOWN = 1;
91 constant
int ERR_FILTER_TYPE_READONLY = 2;
92 constant
int ERR_PROFILE_ALREADY_EXISTS = 3;
93 constant
int ERR_PROFILE_DOES_NOT_EXIST = 4;
94 constant
int ERR_PROFILE_IS_DEFAULT = 5;
95 constant
int ERR_PROFILE_IS_BUILTIN = 6;
96 constant
int ERR_PROFILE_NAME_TOO_LONG = 7;
97 constant
int ERR_PROFILE_NAME_INVALID = 8;
98 constant
int ERR_PROFILE_TOO_MANY = 9;
@ RESTORE_PENDING
Restore is pending.
Definition: BulkConfiguration.idl:18
Bulk Configuration Interface.
Definition: BulkConfiguration.idl:12
int selectDefaultFilterProfile(in string profileName)
Select a new default filter profile.
vector< string > ruleSpecs
filter rule specifications (used only internally)
Definition: BulkConfiguration.idl:48
int modifyFilterProfile(in FilterProfile profile)
Modify an existing filter profile.
vector< FilterProfile > filterProfiles
Defined filter profiles.
Definition: BulkConfiguration.idl:68
Settings.
Definition: BulkConfiguration.idl:67
map< string, FilterType > filterNameToTypeMap
map filter name to type
Definition: BulkConfiguration.idl:61
@ WHITELIST
Whitelist filter (value is part of the bulk configuration)
Definition: BulkConfiguration.idl:36
@ UNKNOWN
No bulk configuration was done yet.
Definition: BulkConfiguration.idl:16
Bulk Configuration.
Definition: BulkConfiguration.idl:9
string description
description of the filter profile
Definition: BulkConfiguration.idl:60
int setSettings(in Settings settings)
Set settings.
int deleteFilterProfile(in string profileName)
Delete an existing filter profile.
string name
name of the filter profile
Definition: BulkConfiguration.idl:59
FilterType
These are the supported supported filter types.
Definition: BulkConfiguration.idl:35
string name
internal name of the filter
Definition: BulkConfiguration.idl:44
boolean bulkOnly
true if filter is not for backup
Definition: BulkConfiguration.idl:47
string getDefaultFilterProfileName()
Retrieve the name of the currently selected default profile.
void getStatus(out Status status, out time timeStamp)
Retrieve the status of the last bulk configuration restore operation.
Status
Status of the last bulk configuration restore operation.
Definition: BulkConfiguration.idl:15
vector< Filter > getFilters()
Retrieve the list of supported filters.
string defaultProfileName
Name of the default profile.
Definition: BulkConfiguration.idl:69
string displayName
name of the filter in the user interface
Definition: BulkConfiguration.idl:45
int addFilterProfile(in FilterProfile profile)
Add a new filter profile.
@ RESTORE_OK
Restoring bulk configuration successful.
Definition: BulkConfiguration.idl:19
boolean noOverride
true if filter is always active and has a fixed type
Definition: BulkConfiguration.idl:46
This structure defines a filter.
Definition: BulkConfiguration.idl:43
vector< FilterProfile > getFilterProfiles()
Retrieve the configured filter profiles.
@ UPLOAD_FAILED
Uploading a bulk configuration failed.
Definition: BulkConfiguration.idl:17
Filter profiles are named collections of filters.
Definition: BulkConfiguration.idl:58
Settings getSettings()
Get settings.