SSLEnabled Property

Whether TLS/SSL is enabled.

Syntax

 snmptcpagent.getSSLEnabled([callback])
 snmptcpagent.setSSLEnabled( SSLEnabled, [callback])

Default Value

FALSE

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getSSLEnabled([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setSSLEnabled([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This setting specifies whether TLS/SSL is enabled in the class. When False (default) the class operates in plaintext mode. When True TLS/SSL is enabled.

Note: SSL is not currently supported in this product. This setting is reserved for future user.

This property is not available at design time.

Data Type

Boolean