Raritan PX2/PX3 JSON-RPC API
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Classes | Public Member Functions | Public Attributes | List of all members
security::Security_3_0_0 Interface Reference

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...
 
void setHttpRedirSettings (in boolean http2httpsRedir)
 Enable or disable HTTP-to-HTTPS redirection. More...
 
int setIpFwSettings (in IpFw_2_0_0 ipFw)
 Set the IP packet filter configuration. More...
 
int setIpV6FwSettings (in IpFw_2_0_0 ipV6Fw)
 Set the IPv6 packet filter configuration. More...
 
int setRoleAccessControlSettings (in RoleAccessControl settings)
 Change the role-based access control settings. More...
 
int setRoleAccessControlSettingsV6 (in RoleAccessControl settings)
 Change the role-based access control settings for IPv6. More...
 
int setBlockSettings (in int blockTimeout, in int maxFailedLogins)
 Change the user blocking settings. More...
 
int setPwSettings (in PasswordSettings pwSettings)
 Change the password settings. More...
 
int setIdleTimeoutSettings (in int idleTimeout)
 Change the session idle timeout. More...
 
void setSingleLoginLimitation (in boolean singleLogin)
 Enable or disable single login limitation. More...
 
int getIdleTimeoutSettings ()
 Retrieve the current idle timeout. More...
 
boolean getHttpRedirSettings ()
 Retrieve the current state of the HTTP-to-HTTPS redirection. More...
 
void getBlockSettings (out int blockTimeout, out int maxFailedLogins)
 Retrieve the current user blocking settings. More...
 
SSHSettings getSSHSettings ()
 Retrieve the current SSH settings. More...
 
void setSSHSettings (in SSHSettings settings)
 Change the SSH settings. 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...
 
int setFrontPanelPrivileges (in vector< string > privileges)
 Set the privileges for the front panel. More...
 
vector< string > getFrontPanelPrivileges ()
 Retrieve the list of active front panel privileges. More...
 

Public Attributes

constant int ERR_INVALID_VALUE = 1
 Invalid arguments.
 

Detailed Description

Security configuration interface

Member Function Documentation

void security::Security_3_0_0::getBlockSettings ( out int  blockTimeout,
out int  maxFailedLogins 
)

Retrieve the current user blocking settings.

Returns
blockTimeout The block timeout in minutes
maxFailedLogins The maximum failure count
vector<string> security::Security_3_0_0::getFrontPanelPrivileges ( )

Retrieve the list of active front panel privileges.

Returns
List of privilege names
boolean security::Security_3_0_0::getHttpRedirSettings ( )

Retrieve the current state of the HTTP-to-HTTPS redirection.

Returns
true if the HTTP-to-HTTPS redirection is enabled
int security::Security_3_0_0::getIdleTimeoutSettings ( )

Retrieve the current idle timeout.

Returns
Idle timeout in minutes
RestrictedServiceAgreement security::Security_3_0_0::getRestrictedServiceAgreement ( )

Retrieve the current Restricted Service Agreement settings.

Returns
Restricted Service Agreement settings
Settings security::Security_3_0_0::getSettings ( )

Retrieve the security configuration.

This method is depreacted and will be removed in V3.0, use concrete getter instead!

Returns
Security configuration
SSHSettings security::Security_3_0_0::getSSHSettings ( )

Retrieve the current SSH settings.

Returns
SSH settings
vector<string> security::Security_3_0_0::getSupportedFrontPanelPrivileges ( )

Retrieve a list of supported privileges for the front panel.

Returns
List of privilege names
int security::Security_3_0_0::setBlockSettings ( in int  blockTimeout,
in int  maxFailedLogins 
)

Change the user blocking settings.

Parameters
blockTimeoutUser blocking timeout in minutes
maxFailedLoginsMaximum number of failed logins
Returns
0 on success
ERR_INVALID_VALUE if any argument was invalid
int security::Security_3_0_0::setFrontPanelPrivileges ( in vector< string >  privileges)

Set the privileges for the front panel.

Returns
0 on success
ERR_INVALID_VALUE if any argument was invalid
void security::Security_3_0_0::setHttpRedirSettings ( in boolean  http2httpsRedir)

Enable or disable HTTP-to-HTTPS redirection.

Parameters
http2httpsRedirtrue to enable the redirection
int security::Security_3_0_0::setIdleTimeoutSettings ( in int  idleTimeout)

Change the session idle timeout.

Parameters
idleTimeoutNew idle timeout in minutes
Returns
0 on success
ERR_INVALID_VALUE if any argument was invalid
int security::Security_3_0_0::setIpFwSettings ( in IpFw_2_0_0  ipFw)

Set the IP packet filter configuration.

Parameters
ipFwNew packet filter settings
Returns
0 on success
ERR_INVALID_VALUE if any argument was invalid
int security::Security_3_0_0::setIpV6FwSettings ( in IpFw_2_0_0  ipV6Fw)

Set the IPv6 packet filter configuration.

Parameters
ipV6FwNew packet filter settings
Returns
0 on success
ERR_INVALID_VALUE if any argument was invalid
int security::Security_3_0_0::setPwSettings ( in PasswordSettings  pwSettings)

Change the password settings.

Parameters
pwSettingsNew settings
Returns
0 on success
ERR_INVALID_VALUE if any argument was invalid
int security::Security_3_0_0::setRestrictedServiceAgreement ( in RestrictedServiceAgreement  settings)

Change the Restricted Service Agreement settings.

Parameters
settingsNew settings
Returns
0 on success
ERR_INVALID_VALUE if any argument was invalid
int security::Security_3_0_0::setRoleAccessControlSettings ( in RoleAccessControl  settings)

Change the role-based access control settings.

Parameters
settingsNew settings
Returns
0 on success
ERR_INVALID_VALUE if any argument was invalid
int security::Security_3_0_0::setRoleAccessControlSettingsV6 ( in RoleAccessControl  settings)

Change the role-based access control settings for IPv6.

Parameters
settingsNew settings
Returns
0 on success
ERR_INVALID_VALUE if any argument was invalid
int security::Security_3_0_0::setSettings ( in Settings  settings)

Set the security configuration.

This method is depreacted and will be removed in V3.0, use concrete setter instead!

Parameters
settingsNew security settings
Returns
0 on success
ERR_INVALID_VALUE if any argument was invalid
void security::Security_3_0_0::setSingleLoginLimitation ( in boolean  singleLogin)

Enable or disable single login limitation.

Parameters
singleLogintrue to enable single login limitation
void security::Security_3_0_0::setSSHSettings ( in SSHSettings  settings)

Change the SSH settings.

Parameters
settingsNew settings

The documentation for this interface was generated from the following file: