Raritan PX2/PX3 JSON-RPC API
|
Security configuration interface More...
import"Security.idl";
Classes | |
struct | Settings |
Security configuration This structure is deprecated and will be removed in V3.0, use concrete getters and setters instead! More... | |
Public Member Functions | |
Settings | getSettings () |
Retrieve the security configuration. More... | |
int | setSettings (in Settings settings) |
Set the security configuration. More... | |
boolean | getHttpRedirSettings () |
Retrieve the current state of the HTTP-to-HTTPS redirection. More... | |
void | setHttpRedirSettings (in boolean http2httpsRedir) |
Enable or disable HTTP-to-HTTPS redirection. More... | |
boolean | isHstsEnabled () |
Check whether HTTP Strict Transport Security (HSTS) is enabled. More... | |
void | setHstsEnabled (in boolean enable) |
Enable or disable HTTP Strict Transport Security (HSTS). More... | |
IpFw_2_0_0 | getIpFwSettings () |
Retrieve the IPv4 packet filter configuration. More... | |
int | setIpFwSettings (in IpFw_2_0_0 ipFw) |
Set the IPv4 packet filter configuration. More... | |
IpFw_2_0_0 | getIpV6FwSettings () |
Retrieve the IPv6 packet filter configuration. More... | |
int | setIpV6FwSettings (in IpFw_2_0_0 ipV6Fw) |
Set the IPv6 packet filter configuration. More... | |
RoleAccessControl | getRoleAccessControlSettings () |
Retrieve the role-base access control settings for IPv4. More... | |
int | setRoleAccessControlSettings (in RoleAccessControl settings) |
Change the role-based access control settings. More... | |
RoleAccessControl | getRoleAccessControlSettingsV6 () |
Retrieve the role-base access control settings for IPv6. More... | |
int | setRoleAccessControlSettingsV6 (in RoleAccessControl settings) |
Change the role-based access control settings for IPv6. More... | |
void | getBlockSettings (out int blockTimeout, out int maxFailedLogins) |
Retrieve the current user blocking settings. More... | |
int | setBlockSettings (in int blockTimeout, in int maxFailedLogins) |
Change the user blocking settings. More... | |
PasswordSettings | getPwSettings () |
Retrieve the password settings. More... | |
int | setPwSettings (in PasswordSettings pwSettings) |
Change the password settings. More... | |
int | getIdleTimeoutSettings () |
Retrieve the current idle timeout. More... | |
int | setIdleTimeoutSettings (in int idleTimeout) |
Change the session idle timeout. More... | |
boolean | getSingleLoginLimitation () |
Retrieve the current single-login limitation setting. More... | |
void | setSingleLoginLimitation (in boolean singleLogin) |
Enable or disable single login limitation. More... | |
SSHSettings | getSSHSettings () |
Retrieve the current SSH settings. More... | |
void | setSSHSettings (in SSHSettings settings) |
Change the SSH settings. More... | |
vector< SSHHostKey > | getSSHHostKeys () |
Retrieve the host SSH keys. More... | |
RestrictedServiceAgreement | getRestrictedServiceAgreement () |
Retrieve the current Restricted Service Agreement settings. More... | |
int | setRestrictedServiceAgreement (in RestrictedServiceAgreement settings) |
Change the Restricted Service Agreement settings. More... | |
vector< string > | getSupportedFrontPanelPrivileges () |
Retrieve a list of supported privileges for the front panel. More... | |
vector< string > | getFrontPanelPrivileges () |
Retrieve the list of active front panel privileges. More... | |
int | setFrontPanelPrivileges (in vector< string > privileges) |
Set the privileges for the front panel. More... | |
int | setDefaultAdminAccountPassword (in string password, in boolean disableStrongPasswordReq) |
Set the default admin account password and optionally disable strong password requirements. More... | |
Public Attributes | |
constant int | ERR_INVALID_VALUE = 1 |
Invalid arguments. | |
Security configuration interface
void security::Security_3_0_3::getBlockSettings | ( | out int | blockTimeout, |
out int | maxFailedLogins | ||
) |
Retrieve the current user blocking settings.
vector<string> security::Security_3_0_3::getFrontPanelPrivileges | ( | ) |
Retrieve the list of active front panel privileges.
boolean security::Security_3_0_3::getHttpRedirSettings | ( | ) |
Retrieve the current state of the HTTP-to-HTTPS redirection.
true
if the HTTP-to-HTTPS redirection is enabled int security::Security_3_0_3::getIdleTimeoutSettings | ( | ) |
Retrieve the current idle timeout.
IpFw_2_0_0 security::Security_3_0_3::getIpFwSettings | ( | ) |
Retrieve the IPv4 packet filter configuration.
IpFw_2_0_0 security::Security_3_0_3::getIpV6FwSettings | ( | ) |
Retrieve the IPv6 packet filter configuration.
PasswordSettings security::Security_3_0_3::getPwSettings | ( | ) |
Retrieve the password settings.
RestrictedServiceAgreement security::Security_3_0_3::getRestrictedServiceAgreement | ( | ) |
Retrieve the current Restricted Service Agreement settings.
RoleAccessControl security::Security_3_0_3::getRoleAccessControlSettings | ( | ) |
Retrieve the role-base access control settings for IPv4.
RoleAccessControl security::Security_3_0_3::getRoleAccessControlSettingsV6 | ( | ) |
Retrieve the role-base access control settings for IPv6.
Settings security::Security_3_0_3::getSettings | ( | ) |
Retrieve the security configuration.
This method is depreacted and will be removed in V3.0, use concrete getter instead!
boolean security::Security_3_0_3::getSingleLoginLimitation | ( | ) |
Retrieve the current single-login limitation setting.
true
if single-login limitation is enabled vector<SSHHostKey> security::Security_3_0_3::getSSHHostKeys | ( | ) |
Retrieve the host SSH keys.
SSHSettings security::Security_3_0_3::getSSHSettings | ( | ) |
Retrieve the current SSH settings.
vector<string> security::Security_3_0_3::getSupportedFrontPanelPrivileges | ( | ) |
Retrieve a list of supported privileges for the front panel.
boolean security::Security_3_0_3::isHstsEnabled | ( | ) |
Check whether HTTP Strict Transport Security (HSTS) is enabled.
true
when HSTS is enabled int security::Security_3_0_3::setBlockSettings | ( | in int | blockTimeout, |
in int | maxFailedLogins | ||
) |
Change the user blocking settings.
blockTimeout | User blocking timeout in minutes |
maxFailedLogins | Maximum number of failed logins |
int security::Security_3_0_3::setDefaultAdminAccountPassword | ( | in string | password, |
in boolean | disableStrongPasswordReq | ||
) |
Set the default admin account password and optionally disable strong password requirements.
The purpose of this method is to set the default admin account password when the device is unprovisioned, i.e. has not been configured yet or has been reset to factory defaults. The difference to the regular setAccountPassword() method in the User::idl is that this method allows to disable the strong password requirements at the same time. It allows choosing a weaker password in case strong password requirements are not needed for the specific purpose.
password | The new password |
disableStrongPasswordReq | true to disable strong password requirements false to keep the current strong password requirement setting |
int security::Security_3_0_3::setFrontPanelPrivileges | ( | in vector< string > | privileges | ) |
Set the privileges for the front panel.
void security::Security_3_0_3::setHstsEnabled | ( | in boolean | enable | ) |
Enable or disable HTTP Strict Transport Security (HSTS).
enable | true to enable HSTS |
void security::Security_3_0_3::setHttpRedirSettings | ( | in boolean | http2httpsRedir | ) |
Enable or disable HTTP-to-HTTPS redirection.
http2httpsRedir | true to enable the redirection |
int security::Security_3_0_3::setIdleTimeoutSettings | ( | in int | idleTimeout | ) |
Change the session idle timeout.
idleTimeout | New idle timeout in minutes |
int security::Security_3_0_3::setIpFwSettings | ( | in IpFw_2_0_0 | ipFw | ) |
Set the IPv4 packet filter configuration.
ipFw | New packet filter settings |
int security::Security_3_0_3::setIpV6FwSettings | ( | in IpFw_2_0_0 | ipV6Fw | ) |
Set the IPv6 packet filter configuration.
ipV6Fw | New packet filter settings |
int security::Security_3_0_3::setPwSettings | ( | in PasswordSettings | pwSettings | ) |
Change the password settings.
pwSettings | New settings |
int security::Security_3_0_3::setRestrictedServiceAgreement | ( | in RestrictedServiceAgreement | settings | ) |
Change the Restricted Service Agreement settings.
settings | New settings |
int security::Security_3_0_3::setRoleAccessControlSettings | ( | in RoleAccessControl | settings | ) |
Change the role-based access control settings.
settings | New settings |
int security::Security_3_0_3::setRoleAccessControlSettingsV6 | ( | in RoleAccessControl | settings | ) |
Change the role-based access control settings for IPv6.
settings | New settings |
int security::Security_3_0_3::setSettings | ( | in Settings | settings | ) |
Set the security configuration.
This method is depreacted and will be removed in V3.0, use concrete setter instead!
settings | New security settings |
void security::Security_3_0_3::setSingleLoginLimitation | ( | in boolean | singleLogin | ) |
Enable or disable single login limitation.
singleLogin | true to enable single login limitation |
void security::Security_3_0_3::setSSHSettings | ( | in SSHSettings | settings | ) |
Change the SSH settings.
settings | New settings |