| Raritan PX2/PX3 JSON-RPC API
    | 
Bulk Configuration Interface. More...
import"BulkConfiguration.idl";
| Classes | |
| struct | Filter | 
| This structure defines a filter.  More... | |
| struct | FilterProfile | 
| Filter profiles are named collections of filters.  More... | |
| struct | Settings | 
| Settings.  More... | |
| Public Types | |
| enum | Status { UNKNOWN, UPLOAD_FAILED, RESTORE_PENDING, RESTORE_OK, RESTORE_FAILED } | 
| Status of the last bulk configuration restore operation.  More... | |
| enum | FilterType { WHITELIST, BLACKLIST } | 
| These are the supported supported filter types.  More... | |
| Public Member Functions | |
| void | getStatus (out Status status, out time timeStamp) | 
| Retrieve the status of the last bulk configuration restore operation.  More... | |
| vector< Filter > | getFilters () | 
| Retrieve the list of supported filters.  More... | |
| vector< FilterProfile > | getFilterProfiles () | 
| Retrieve the configured filter profiles.  More... | |
| int | addFilterProfile (in FilterProfile profile) | 
| Add a new filter profile.  More... | |
| int | modifyFilterProfile (in FilterProfile profile) | 
| Modify an existing filter profile.  More... | |
| int | deleteFilterProfile (in string profileName) | 
| Delete an existing filter profile.  More... | |
| string | getDefaultFilterProfileName () | 
| Retrieve the name of the currently selected default profile.  More... | |
| int | selectDefaultFilterProfile (in string profileName) | 
| Select a new default filter profile.  More... | |
| Settings | getSettings () | 
| Get settings.  More... | |
| int | setSettings (in Settings settings) | 
| Set settings.  More... | |
| Public Attributes | |
| valueobject | SettingsChangedEvent: event::UserEvent { } | 
| Event: Bulk configuration settings changed. | |
| valueobject | SavedEvent: event::UserEvent { boolean isBackup | 
| Event: Bulk configuration saved (also used for saving config backup)  More... | |
| valueobject | RestoredEvent: event::UserEvent { boolean isBackup | 
| Event: Bulk configuration restored (also used for restoring config backup)  More... | |
| constant int | SUCCESS = 0 | 
| Error codes.  More... | |
| constant int | ERR_FILTER_NAME_UNKNOWN = 1 | 
| A referenced filter name is unknown. | |
| constant int | ERR_FILTER_TYPE_READONLY = 2 | 
| A referenced filter can't be overridden. | |
| constant int | ERR_PROFILE_ALREADY_EXISTS = 3 | 
| A profile with the given name already exists. | |
| constant int | ERR_PROFILE_DOES_NOT_EXIST = 4 | 
| A profile with the given name does not exist. | |
| constant int | ERR_PROFILE_IS_DEFAULT = 5 | 
| The selected profile is the current default profile. | |
| constant int | ERR_PROFILE_IS_BUILTIN = 6 | 
| The selected profile is the builtin profile. | |
| constant int | ERR_PROFILE_NAME_TOO_LONG = 7 | 
| The profile name is too long. | |
| constant int | ERR_PROFILE_NAME_INVALID = 8 | 
| The profile name contains invalid characters. | |
| constant int | ERR_PROFILE_TOO_MANY = 9 | 
| The maximum number of profiles already exist. | |
Bulk Configuration Interface.
Status of the last bulk configuration restore operation.
| int bulkcfg::BulkConfiguration_1_0_2::addFilterProfile | ( | in FilterProfile | profile | ) | 
Add a new filter profile.
| profile | The new filter profile | 
| int bulkcfg::BulkConfiguration_1_0_2::deleteFilterProfile | ( | in string | profileName | ) | 
Delete an existing filter profile.
| profileName | The name of the profile to be deleted | 
| string bulkcfg::BulkConfiguration_1_0_2::getDefaultFilterProfileName | ( | ) | 
Retrieve the name of the currently selected default profile.
| vector<FilterProfile> bulkcfg::BulkConfiguration_1_0_2::getFilterProfiles | ( | ) | 
Retrieve the configured filter profiles.
| vector<Filter> bulkcfg::BulkConfiguration_1_0_2::getFilters | ( | ) | 
Retrieve the list of supported filters.
| void bulkcfg::BulkConfiguration_1_0_2::getStatus | ( | out Status | status, | 
| out time | timeStamp | ||
| ) | 
Retrieve the status of the last bulk configuration restore operation.
| status | Result: Bulk configuration restore status | 
| timeStamp | Result: Time of last restore operation | 
| int bulkcfg::BulkConfiguration_1_0_2::modifyFilterProfile | ( | in FilterProfile | profile | ) | 
Modify an existing filter profile.
| profile | The updated filter profile | 
| int bulkcfg::BulkConfiguration_1_0_2::selectDefaultFilterProfile | ( | in string | profileName | ) | 
Select a new default filter profile.
| profileName | The name of the new default profile | 
| int bulkcfg::BulkConfiguration_1_0_2::setSettings | ( | in Settings | settings | ) | 
Set settings.
NOTE: The builtin profile will be ignored when present in the list of filter profiles.
| settings | The settings to set | 
| valueobject bulkcfg::BulkConfiguration_1_0_2::RestoredEvent | 
Event: Bulk configuration restored (also used for restoring config backup)
true if the event is caused by restoring a full configuration backup
| valueobject bulkcfg::BulkConfiguration_1_0_2::SavedEvent | 
Event: Bulk configuration saved (also used for saving config backup)
true if the event is caused by saving a full configuration backup
| constant int bulkcfg::BulkConfiguration_1_0_2::SUCCESS = 0 | 
Error codes.
The operation was successful
 1.8.14
 1.8.14